src/jexer/TWindow.java

   1 /*
   2  * Jexer - Java Text User Interface
   3  *
   4  * The MIT License (MIT)
   5  *
   6  * Copyright (C) 2019 Kevin Lamonte
   7  *
   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:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  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.
  25  *
  26  * @author Kevin Lamonte [kevin.lamonte@gmail.com]
  27  * @version 1
  28  */
  29 package jexer;
  30
  31 import java.util.HashSet;
  32 import java.util.Set;
  33
  34 import jexer.backend.Screen;
  35 import jexer.bits.CellAttributes;
  36 import jexer.bits.GraphicsChars;
  37 import jexer.bits.StringUtils;
  38 import jexer.event.TCommandEvent;
  39 import jexer.event.TKeypressEvent;
  40 import jexer.event.TMenuEvent;
  41 import jexer.event.TMouseEvent;
  42 import jexer.event.TResizeEvent;
  43 import jexer.menu.TMenu;
  44 import static jexer.TCommand.*;
  45 import static jexer.TKeypress.*;
  46
  47 /**
  48  * TWindow is the top-level container and drawing surface for other widgets.
  49  */
  50 public class TWindow extends TWidget {
  51
  52     // ------------------------------------------------------------------------
  53     // Constants --------------------------------------------------------------
  54     // ------------------------------------------------------------------------
  55
  56     /**
  57      * Window is resizable (default yes).
  58      */
  59     public static final int RESIZABLE   = 0x01;
  60
  61     /**
  62      * Window is modal (default no).
  63      */
  64     public static final int MODAL       = 0x02;
  65
  66     /**
  67      * Window is centered (default no).
  68      */
  69     public static final int CENTERED    = 0x04;
  70
  71     /**
  72      * Window has no close box (default no).  Window can still be closed via
  73      * TApplication.closeWindow() and TWindow.close().
  74      */
  75     public static final int NOCLOSEBOX  = 0x08;
  76
  77     /**
  78      * Window has no maximize box (default no).
  79      */
  80     public static final int NOZOOMBOX   = 0x10;
  81
  82     /**
  83      * Window is placed at absolute position (no smart placement) (default
  84      * no).
  85      */
  86     public static final int ABSOLUTEXY  = 0x20;
  87
  88     /**
  89      * Hitting the closebox with the mouse calls TApplication.hideWindow()
  90      * rather than TApplication.closeWindow() (default no).
  91      */
  92     public static final int HIDEONCLOSE = 0x40;
  93
  94     /**
  95      * Menus cannot be used when this window is active (default no).
  96      */
  97     public static final int OVERRIDEMENU        = 0x80;
  98
  99     // ------------------------------------------------------------------------
 100     // Variables --------------------------------------------------------------
 101     // ------------------------------------------------------------------------
 102
 103     /**
 104      * Window flags.  Note package private access.
 105      */
 106     int flags = RESIZABLE;
 107
 108     /**
 109      * Window title.
 110      */
 111     private String title = "";
 112
 113     /**
 114      * Window's parent TApplication.
 115      */
 116     private TApplication application;
 117
 118     /**
 119      * Z order.  Lower number means more in-front.
 120      */
 121     private int z = 0;
 122
 123     /**
 124      * Window's keyboard shortcuts.  Any key in this set will be passed to
 125      * the window directly rather than processed through the menu
 126      * accelerators.
 127      */
 128     private Set<TKeypress> keyboardShortcuts = new HashSet<TKeypress>();
 129
 130     /**
 131      * If true, then the user clicked on the title bar and is moving the
 132      * window.
 133      */
 134     protected boolean inWindowMove = false;
 135
 136     /**
 137      * If true, then the user clicked on the bottom right corner and is
 138      * resizing the window.
 139      */
 140     protected boolean inWindowResize = false;
 141
 142     /**
 143      * If true, then the user selected "Size/Move" (or hit Ctrl-F5) and is
 144      * resizing/moving the window via the keyboard.
 145      */
 146     protected boolean inKeyboardResize = false;
 147
 148     /**
 149      * If true, this window is maximized.
 150      */
 151     private boolean maximized = false;
 152
 153     /**
 154      * Remember mouse state.
 155      */
 156     protected TMouseEvent mouse;
 157
 158     // For moving the window.  resizing also uses moveWindowMouseX/Y
 159     private int moveWindowMouseX;
 160     private int moveWindowMouseY;
 161     private int oldWindowX;
 162     private int oldWindowY;
 163
 164     // Resizing
 165     private int resizeWindowWidth;
 166     private int resizeWindowHeight;
 167     private int minimumWindowWidth = 10;
 168     private int minimumWindowHeight = 2;
 169     private int maximumWindowWidth = -1;
 170     private int maximumWindowHeight = -1;
 171
 172     // For maximize/restore
 173     private int restoreWindowWidth;
 174     private int restoreWindowHeight;
 175     private int restoreWindowX;
 176     private int restoreWindowY;
 177
 178     /**
 179      * Hidden flag.  A hidden window will still have its onIdle() called, and
 180      * will also have onClose() called at application exit.  Note package
 181      * private access: TApplication will force hidden false if a modal window
 182      * is active.
 183      */
 184     boolean hidden = false;
 185
 186     /**
 187      * A window may have a status bar associated with it.  TApplication will
 188      * draw this status bar last, and will also route events to it first
 189      * before the window.
 190      */
 191     protected TStatusBar statusBar = null;
 192
 193     /**
 194      * A window may request that TApplication NOT draw the mouse cursor over
 195      * it by setting this to true.  This is currently only used within Jexer
 196      * by TTerminalWindow so that only the bottom-most instance of nested
 197      * Jexer's draws the mouse within its application window.  But perhaps
 198      * other applications can use it, so public getter/setter is provided.
 199      */
 200     private boolean hideMouse = false;
 201
 202     // ------------------------------------------------------------------------
 203     // Constructors -----------------------------------------------------------
 204     // ------------------------------------------------------------------------
 205
 206     /**
 207      * Public constructor.  Window will be located at (0, 0).
 208      *
 209      * @param application TApplication that manages this window
 210      * @param title window title, will be centered along the top border
 211      * @param width width of window
 212      * @param height height of window
 213      */
 214     public TWindow(final TApplication application, final String title,
 215         final int width, final int height) {
 216
 217         this(application, title, 0, 0, width, height, RESIZABLE);
 218     }
 219
 220     /**
 221      * Public constructor.  Window will be located at (0, 0).
 222      *
 223      * @param application TApplication that manages this window
 224      * @param title window title, will be centered along the top border
 225      * @param width width of window
 226      * @param height height of window
 227      * @param flags bitmask of RESIZABLE, CENTERED, or MODAL
 228      */
 229     public TWindow(final TApplication application, final String title,
 230         final int width, final int height, final int flags) {
 231
 232         this(application, title, 0, 0, width, height, flags);
 233     }
 234
 235     /**
 236      * Public constructor.
 237      *
 238      * @param application TApplication that manages this window
 239      * @param title window title, will be centered along the top border
 240      * @param x column relative to parent
 241      * @param y row relative to parent
 242      * @param width width of window
 243      * @param height height of window
 244      */
 245     public TWindow(final TApplication application, final String title,
 246         final int x, final int y, final int width, final int height) {
 247
 248         this(application, title, x, y, width, height, RESIZABLE);
 249     }
 250
 251     /**
 252      * Public constructor.
 253      *
 254      * @param application TApplication that manages this window
 255      * @param title window title, will be centered along the top border
 256      * @param x column relative to parent
 257      * @param y row relative to parent
 258      * @param width width of window
 259      * @param height height of window
 260      * @param flags mask of RESIZABLE, CENTERED, or MODAL
 261      */
 262     public TWindow(final TApplication application, final String title,
 263         final int x, final int y, final int width, final int height,
 264         final int flags) {
 265
 266         super();
 267
 268         // I am my own window and parent
 269         setupForTWindow(this, x, y + application.getDesktopTop(),
 270             width, height);
 271
 272         // Save fields
 273         this.title       = title;
 274         this.application = application;
 275         this.flags       = flags;
 276
 277         // Minimum width/height are 10 and 2
 278         assert (width >= 10);
 279         assert (getHeight() >= 2);
 280
 281         // MODAL implies CENTERED
 282         if (isModal()) {
 283             this.flags |= CENTERED;
 284         }
 285
 286         // Center window if specified
 287         center();
 288
 289         // Add me to the application
 290         application.addWindowToApplication(this);
 291     }
 292
 293     // ------------------------------------------------------------------------
 294     // Event handlers ---------------------------------------------------------
 295     // ------------------------------------------------------------------------
 296
 297     /**
 298      * Returns true if the mouse is currently on the close button.
 299      *
 300      * @return true if mouse is currently on the close button
 301      */
 302     protected boolean mouseOnClose() {
 303         if ((flags & NOCLOSEBOX) != 0) {
 304             return false;
 305         }
 306         if ((mouse != null)
 307             && (mouse.getAbsoluteY() == getY())
 308             && (mouse.getAbsoluteX() == getX() + 3)
 309         ) {
 310             return true;
 311         }
 312         return false;
 313     }
 314
 315     /**
 316      * Returns true if the mouse is currently on the maximize/restore button.
 317      *
 318      * @return true if the mouse is currently on the maximize/restore button
 319      */
 320     protected boolean mouseOnMaximize() {
 321         if ((flags & NOZOOMBOX) != 0) {
 322             return false;
 323         }
 324         if ((mouse != null)
 325             && !isModal()
 326             && (mouse.getAbsoluteY() == getY())
 327             && (mouse.getAbsoluteX() == getX() + getWidth() - 4)
 328         ) {
 329             return true;
 330         }
 331         return false;
 332     }
 333
 334     /**
 335      * Returns true if the mouse is currently on the resizable lower right
 336      * corner.
 337      *
 338      * @return true if the mouse is currently on the resizable lower right
 339      * corner
 340      */
 341     protected boolean mouseOnResize() {
 342         if (((flags & RESIZABLE) != 0)
 343             && !isModal()
 344             && (mouse != null)
 345             && (mouse.getAbsoluteY() == getY() + getHeight() - 1)
 346             && ((mouse.getAbsoluteX() == getX() + getWidth() - 1)
 347                 || (mouse.getAbsoluteX() == getX() + getWidth() - 2))
 348         ) {
 349             return true;
 350         }
 351         return false;
 352     }
 353
 354     /**
 355      * Subclasses should override this method to perform any user prompting
 356      * before they are offscreen.  Note that unlike other windowing toolkits,
 357      * windows can NOT use this function in some manner to avoid being
 358      * closed.  This is called by application.closeWindow().
 359      */
 360     protected void onPreClose() {
 361         // Default: do nothing.
 362     }
 363
 364     /**
 365      * Subclasses should override this method to cleanup resources.  This is
 366      * called by application.closeWindow().
 367      */
 368     protected void onClose() {
 369         // Default: perform widget-specific cleanup.
 370         for (TWidget w: getChildren()) {
 371             w.close();
 372         }
 373     }
 374
 375     /**
 376      * Called by application.switchWindow() when this window gets the
 377      * focus, and also by application.addWindow().
 378      */
 379     protected void onFocus() {
 380         // Default: do nothing
 381     }
 382
 383     /**
 384      * Called by application.switchWindow() when another window gets the
 385      * focus.
 386      */
 387     protected void onUnfocus() {
 388         // Default: do nothing
 389     }
 390
 391     /**
 392      * Called by application.hideWindow().
 393      */
 394     protected void onHide() {
 395         // Default: do nothing
 396     }
 397
 398     /**
 399      * Called by application.showWindow().
 400      */
 401     protected void onShow() {
 402         // Default: do nothing
 403     }
 404
 405     /**
 406      * Handle mouse button presses.
 407      *
 408      * @param mouse mouse button event
 409      */
 410     @Override
 411     public void onMouseDown(final TMouseEvent mouse) {
 412         this.mouse = mouse;
 413
 414         inKeyboardResize = false;
 415         inWindowMove = false;
 416         inWindowResize = false;
 417
 418         if ((mouse.getAbsoluteY() == getY())
 419             && mouse.isMouse1()
 420             && (getX() <= mouse.getAbsoluteX())
 421             && (mouse.getAbsoluteX() < getX() + getWidth())
 422             && !mouseOnClose()
 423             && !mouseOnMaximize()
 424         ) {
 425             // Begin moving window
 426             inWindowMove = true;
 427             moveWindowMouseX = mouse.getAbsoluteX();
 428             moveWindowMouseY = mouse.getAbsoluteY();
 429             oldWindowX = getX();
 430             oldWindowY = getY();
 431             if (maximized) {
 432                 maximized = false;
 433             }
 434             return;
 435         }
 436         if (mouseOnResize()) {
 437             // Begin window resize
 438             inWindowResize = true;
 439             moveWindowMouseX = mouse.getAbsoluteX();
 440             moveWindowMouseY = mouse.getAbsoluteY();
 441             resizeWindowWidth = getWidth();
 442             resizeWindowHeight = getHeight();
 443             if (maximized) {
 444                 maximized = false;
 445             }
 446             return;
 447         }
 448
 449         // Give the shortcut bar a shot at this.
 450         if (statusBar != null) {
 451             if (statusBar.statusBarMouseDown(mouse)) {
 452                 return;
 453             }
 454         }
 455
 456         // I didn't take it, pass it on to my children
 457         super.onMouseDown(mouse);
 458     }
 459
 460     /**
 461      * Handle mouse button releases.
 462      *
 463      * @param mouse mouse button release event
 464      */
 465     @Override
 466     public void onMouseUp(final TMouseEvent mouse) {
 467         this.mouse = mouse;
 468
 469         if ((inWindowMove) && (mouse.isMouse1())) {
 470             // Stop moving window
 471             inWindowMove = false;
 472             return;
 473         }
 474
 475         if ((inWindowResize) && (mouse.isMouse1())) {
 476             // Stop resizing window
 477             inWindowResize = false;
 478             return;
 479         }
 480
 481         if (mouse.isMouse1() && mouseOnClose()) {
 482             if ((flags & HIDEONCLOSE) == 0) {
 483                 // Close window
 484                 application.closeWindow(this);
 485             } else {
 486                 // Hide window
 487                 application.hideWindow(this);
 488             }
 489             return;
 490         }
 491
 492         if ((mouse.getAbsoluteY() == getY())
 493             && mouse.isMouse1()
 494             && mouseOnMaximize()) {
 495             if (maximized) {
 496                 // Restore
 497                 restore();
 498             } else {
 499                 // Maximize
 500                 maximize();
 501             }
 502             // Pass a resize event to my children
 503             onResize(new TResizeEvent(TResizeEvent.Type.WIDGET,
 504                     getWidth(), getHeight()));
 505             return;
 506         }
 507
 508         // Give the shortcut bar a shot at this.
 509         if (statusBar != null) {
 510             if (statusBar.statusBarMouseUp(mouse)) {
 511                 return;
 512             }
 513         }
 514
 515         // I didn't take it, pass it on to my children
 516         super.onMouseUp(mouse);
 517     }
 518
 519     /**
 520      * Handle mouse movements.
 521      *
 522      * @param mouse mouse motion event
 523      */
 524     @Override
 525     public void onMouseMotion(final TMouseEvent mouse) {
 526         this.mouse = mouse;
 527
 528         if (inWindowMove) {
 529             // Move window over
 530             setX(oldWindowX + (mouse.getAbsoluteX() - moveWindowMouseX));
 531             setY(oldWindowY + (mouse.getAbsoluteY() - moveWindowMouseY));
 532             // Don't cover up the menu bar
 533             if (getY() < application.getDesktopTop()) {
 534                 setY(application.getDesktopTop());
 535             }
 536             // Don't go below the status bar
 537             if (getY() >= application.getDesktopBottom()) {
 538                 setY(application.getDesktopBottom() - 1);
 539             }
 540             return;
 541         }
 542
 543         if (inWindowResize) {
 544             // Do not permit resizing below the status line
 545             if (mouse.getAbsoluteY() == application.getDesktopBottom()) {
 546                 inWindowResize = false;
 547                 return;
 548             }
 549
 550             // Move window over
 551             setWidth(resizeWindowWidth + (mouse.getAbsoluteX()
 552                     - moveWindowMouseX));
 553             setHeight(resizeWindowHeight + (mouse.getAbsoluteY()
 554                     - moveWindowMouseY));
 555             if (getX() + getWidth() > getScreen().getWidth()) {
 556                 setWidth(getScreen().getWidth() - getX());
 557             }
 558             if (getY() + getHeight() > application.getDesktopBottom()) {
 559                 setY(application.getDesktopBottom() - getHeight() + 1);
 560             }
 561             // Don't cover up the menu bar
 562             if (getY() < application.getDesktopTop()) {
 563                 setY(application.getDesktopTop());
 564             }
 565
 566             // Keep within min/max bounds
 567             if (getWidth() < minimumWindowWidth) {
 568                 setWidth(minimumWindowWidth);
 569                 inWindowResize = false;
 570             }
 571             if (getHeight() < minimumWindowHeight) {
 572                 setHeight(minimumWindowHeight);
 573                 inWindowResize = false;
 574             }
 575             if ((maximumWindowWidth > 0)
 576                 && (getWidth() > maximumWindowWidth)
 577             ) {
 578                 setWidth(maximumWindowWidth);
 579                 inWindowResize = false;
 580             }
 581             if ((maximumWindowHeight > 0)
 582                 && (getHeight() > maximumWindowHeight)
 583             ) {
 584                 setHeight(maximumWindowHeight);
 585                 inWindowResize = false;
 586             }
 587
 588             // Pass a resize event to my children
 589             onResize(new TResizeEvent(TResizeEvent.Type.WIDGET,
 590                     getWidth(), getHeight()));
 591             return;
 592         }
 593
 594         // Give the shortcut bar a shot at this.
 595         if (statusBar != null) {
 596             statusBar.statusBarMouseMotion(mouse);
 597         }
 598
 599         // I didn't take it, pass it on to my children
 600         super.onMouseMotion(mouse);
 601     }
 602
 603     /**
 604      * Handle keystrokes.
 605      *
 606      * @param keypress keystroke event
 607      */
 608     @Override
 609     public void onKeypress(final TKeypressEvent keypress) {
 610
 611         if (inKeyboardResize) {
 612
 613             // ESC or ENTER - Exit size/move
 614             if (keypress.equals(kbEsc) || keypress.equals(kbEnter)) {
 615                 inKeyboardResize = false;
 616             }
 617
 618             if (keypress.equals(kbLeft)) {
 619                 if (getX() > 0) {
 620                     setX(getX() - 1);
 621                 }
 622             }
 623             if (keypress.equals(kbRight)) {
 624                 if (getX() < getScreen().getWidth() - 1) {
 625                     setX(getX() + 1);
 626                 }
 627             }
 628             if (keypress.equals(kbDown)) {
 629                 if (getY() < application.getDesktopBottom() - 1) {
 630                     setY(getY() + 1);
 631                 }
 632             }
 633             if (keypress.equals(kbUp)) {
 634                 if (getY() > 1) {
 635                     setY(getY() - 1);
 636                 }
 637             }
 638
 639             /*
 640              * Only permit keyboard resizing if the window was RESIZABLE.
 641              */
 642             if ((flags & RESIZABLE) != 0) {
 643
 644                 if (keypress.equals(kbShiftLeft)) {
 645                     if ((getWidth() > minimumWindowWidth)
 646                         || (minimumWindowWidth <= 0)
 647                     ) {
 648                         setWidth(getWidth() - 1);
 649                     }
 650                 }
 651                 if (keypress.equals(kbShiftRight)) {
 652                     if ((getWidth() < maximumWindowWidth)
 653                         || (maximumWindowWidth <= 0)
 654                     ) {
 655                         setWidth(getWidth() + 1);
 656                     }
 657                 }
 658                 if (keypress.equals(kbShiftUp)) {
 659                     if ((getHeight() > minimumWindowHeight)
 660                         || (minimumWindowHeight <= 0)
 661                     ) {
 662                         setHeight(getHeight() - 1);
 663                     }
 664                 }
 665                 if (keypress.equals(kbShiftDown)) {
 666                     if ((getHeight() < maximumWindowHeight)
 667                         || (maximumWindowHeight <= 0)
 668                     ) {
 669                         setHeight(getHeight() + 1);
 670                     }
 671                 }
 672
 673                 // Pass a resize event to my children
 674                 onResize(new TResizeEvent(TResizeEvent.Type.WIDGET,
 675                         getWidth(), getHeight()));
 676
 677             } // if ((flags & RESIZABLE) != 0)
 678
 679             return;
 680         }
 681
 682         // Give the shortcut bar a shot at this.
 683         if (statusBar != null) {
 684             if (statusBar.statusBarKeypress(keypress)) {
 685                 return;
 686             }
 687         }
 688
 689         // These keystrokes will typically not be seen unless a subclass
 690         // overrides onMenu() due to how TApplication dispatches
 691         // accelerators.
 692
 693         if (!(this instanceof TDesktop)) {
 694
 695             // Ctrl-W - close window
 696             if (keypress.equals(kbCtrlW)) {
 697                 if ((flags & NOCLOSEBOX) == 0) {
 698                     if ((flags & HIDEONCLOSE) == 0) {
 699                         // Close window
 700                         application.closeWindow(this);
 701                     } else {
 702                         // Hide window
 703                         application.hideWindow(this);
 704                     }
 705                 }
 706                 return;
 707             }
 708
 709             // F6 - behave like Alt-TAB
 710             if (keypress.equals(kbF6)) {
 711                 application.switchWindow(true);
 712                 return;
 713             }
 714
 715             // Shift-F6 - behave like Shift-Alt-TAB
 716             if (keypress.equals(kbShiftF6)) {
 717                 application.switchWindow(false);
 718                 return;
 719             }
 720
 721             // F5 - zoom
 722             if (keypress.equals(kbF5) && ((flags & NOZOOMBOX) == 0)) {
 723                 if (maximized) {
 724                     restore();
 725                 } else {
 726                     maximize();
 727                 }
 728             }
 729
 730             // Ctrl-F5 - size/move
 731             if (keypress.equals(kbCtrlF5)) {
 732                 inKeyboardResize = !inKeyboardResize;
 733             }
 734
 735         } // if (!(this instanceof TDesktop))
 736
 737         // I didn't take it, pass it on to my children
 738         super.onKeypress(keypress);
 739     }
 740
 741     /**
 742      * Handle posted command events.
 743      *
 744      * @param command command event
 745      */
 746     @Override
 747     public void onCommand(final TCommandEvent command) {
 748
 749         // These commands will typically not be seen unless a subclass
 750         // overrides onMenu() due to how TApplication dispatches
 751         // accelerators.
 752
 753         if (!(this instanceof TDesktop)) {
 754
 755             if (command.equals(cmWindowClose)) {
 756                 if ((flags & NOCLOSEBOX) == 0) {
 757                     if ((flags & HIDEONCLOSE) == 0) {
 758                         // Close window
 759                         application.closeWindow(this);
 760                     } else {
 761                         // Hide window
 762                         application.hideWindow(this);
 763                     }
 764                 }
 765                 return;
 766             }
 767
 768             if (command.equals(cmWindowNext)) {
 769                 application.switchWindow(true);
 770                 return;
 771             }
 772
 773             if (command.equals(cmWindowPrevious)) {
 774                 application.switchWindow(false);
 775                 return;
 776             }
 777
 778             if (command.equals(cmWindowMove)) {
 779                 inKeyboardResize = true;
 780                 return;
 781             }
 782
 783             if (command.equals(cmWindowZoom) && ((flags & NOZOOMBOX) == 0)) {
 784                 if (maximized) {
 785                     restore();
 786                 } else {
 787                     maximize();
 788                 }
 789             }
 790
 791         } // if (!(this instanceof TDesktop))
 792
 793         // I didn't take it, pass it on to my children
 794         super.onCommand(command);
 795     }
 796
 797     /**
 798      * Handle posted menu events.
 799      *
 800      * @param menu menu event
 801      */
 802     @Override
 803     public void onMenu(final TMenuEvent menu) {
 804
 805         if (!(this instanceof TDesktop)) {
 806
 807             if (menu.getId() == TMenu.MID_WINDOW_CLOSE) {
 808                 if ((flags & NOCLOSEBOX) == 0) {
 809                     if ((flags & HIDEONCLOSE) == 0) {
 810                         // Close window
 811                         application.closeWindow(this);
 812                     } else {
 813                         // Hide window
 814                         application.hideWindow(this);
 815                     }
 816                 }
 817                 return;
 818             }
 819
 820             if (menu.getId() == TMenu.MID_WINDOW_NEXT) {
 821                 application.switchWindow(true);
 822                 return;
 823             }
 824
 825             if (menu.getId() == TMenu.MID_WINDOW_PREVIOUS) {
 826                 application.switchWindow(false);
 827                 return;
 828             }
 829
 830             if (menu.getId() == TMenu.MID_WINDOW_MOVE) {
 831                 inKeyboardResize = true;
 832                 return;
 833             }
 834
 835             if ((menu.getId() == TMenu.MID_WINDOW_ZOOM)
 836                 && ((flags & NOZOOMBOX) == 0)
 837             ) {
 838                 if (maximized) {
 839                     restore();
 840                 } else {
 841                     maximize();
 842                 }
 843                 return;
 844             }
 845
 846         } // if (!(this instanceof TDesktop))
 847
 848         // I didn't take it, pass it on to my children
 849         super.onMenu(menu);
 850     }
 851
 852     /**
 853      * Method that subclasses can override to handle window/screen resize
 854      * events.
 855      *
 856      * @param resize resize event
 857      */
 858     @Override
 859     public void onResize(final TResizeEvent resize) {
 860         if (resize.getType() == TResizeEvent.Type.WIDGET) {
 861             if (getChildren().size() == 1) {
 862                 TWidget child = getChildren().get(0);
 863                 if ((child instanceof TSplitPane)
 864                     || (child instanceof TPanel)
 865                 ) {
 866                     if (this instanceof TDesktop) {
 867                         child.onResize(new TResizeEvent(
 868                             TResizeEvent.Type.WIDGET,
 869                             resize.getWidth(), resize.getHeight()));
 870                     } else {
 871                         child.onResize(new TResizeEvent(
 872                             TResizeEvent.Type.WIDGET,
 873                             resize.getWidth() - 2, resize.getHeight() - 2));
 874                     }
 875                 }
 876                 return;
 877             }
 878         }
 879
 880         // Pass on to TWidget.
 881         super.onResize(resize);
 882     }
 883
 884     // ------------------------------------------------------------------------
 885     // TWidget ----------------------------------------------------------------
 886     // ------------------------------------------------------------------------
 887
 888     /**
 889      * Get this TWindow's parent TApplication.
 890      *
 891      * @return this TWindow's parent TApplication
 892      */
 893     @Override
 894     public final TApplication getApplication() {
 895         return application;
 896     }
 897
 898     /**
 899      * Get the Screen.
 900      *
 901      * @return the Screen
 902      */
 903     @Override
 904     public final Screen getScreen() {
 905         return application.getScreen();
 906     }
 907
 908     /**
 909      * Called by TApplication.drawChildren() to render on screen.
 910      */
 911     @Override
 912     public void draw() {
 913         // Draw the box and background first.
 914         CellAttributes border = getBorder();
 915         CellAttributes background = getBackground();
 916         int borderType = getBorderType();
 917
 918         drawBox(0, 0, getWidth(), getHeight(), border, background, borderType,
 919             true);
 920
 921         // Draw the title
 922         int titleLength = StringUtils.width(title);
 923         int titleLeft = (getWidth() - titleLength - 2) / 2;
 924         putCharXY(titleLeft, 0, ' ', border);
 925         putStringXY(titleLeft + 1, 0, title, border);
 926         putCharXY(titleLeft + titleLength + 1, 0, ' ', border);
 927
 928         if (isActive()) {
 929
 930             // Draw the close button
 931             if ((flags & NOCLOSEBOX) == 0) {
 932                 putCharXY(2, 0, '[', border);
 933                 putCharXY(4, 0, ']', border);
 934                 if (mouseOnClose() && mouse.isMouse1()) {
 935                     putCharXY(3, 0, GraphicsChars.CP437[0x0F],
 936                         getBorderControls());
 937                 } else {
 938                     putCharXY(3, 0, GraphicsChars.CP437[0xFE],
 939                         getBorderControls());
 940                 }
 941             }
 942
 943             // Draw the maximize button
 944             if (!isModal() && ((flags & NOZOOMBOX) == 0)) {
 945
 946                 putCharXY(getWidth() - 5, 0, '[', border);
 947                 putCharXY(getWidth() - 3, 0, ']', border);
 948                 if (mouseOnMaximize() && mouse.isMouse1()) {
 949                     putCharXY(getWidth() - 4, 0, GraphicsChars.CP437[0x0F],
 950                         getBorderControls());
 951                 } else {
 952                     if (maximized) {
 953                         putCharXY(getWidth() - 4, 0, GraphicsChars.CP437[0x12],
 954                             getBorderControls());
 955                     } else {
 956                         putCharXY(getWidth() - 4, 0, GraphicsChars.UPARROW,
 957                             getBorderControls());
 958                     }
 959                 }
 960
 961                 // Draw the resize corner
 962                 if ((flags & RESIZABLE) != 0) {
 963                     putCharXY(getWidth() - 2, getHeight() - 1,
 964                         GraphicsChars.SINGLE_BAR, getBorderControls());
 965                     putCharXY(getWidth() - 1, getHeight() - 1,
 966                         GraphicsChars.LRCORNER, getBorderControls());
 967                 }
 968             }
 969         }
 970     }
 971
 972     // ------------------------------------------------------------------------
 973     // TWindow ----------------------------------------------------------------
 974     // ------------------------------------------------------------------------
 975
 976     /**
 977      * Get window title.
 978      *
 979      * @return window title
 980      */
 981     public final String getTitle() {
 982         return title;
 983     }
 984
 985     /**
 986      * Set window title.
 987      *
 988      * @param title new window title
 989      */
 990     public final void setTitle(final String title) {
 991         this.title = title;
 992     }
 993
 994     /**
 995      * Get Z order.  Lower number means more in-front.
 996      *
 997      * @return Z value.  Lower number means more in-front.
 998      */
 999     public final int getZ() {
1000         return z;
1001     }
1002
1003     /**
1004      * Set Z order.  Lower number means more in-front.
1005      *
1006      * @param z the new Z value.  Lower number means more in-front.
1007      */
1008     public final void setZ(final int z) {
1009         this.z = z;
1010     }
1011
1012     /**
1013      * Add a keypress to be overridden for this window.
1014      *
1015      * @param key the key to start taking control of
1016      */
1017     protected void addShortcutKeypress(final TKeypress key) {
1018         keyboardShortcuts.add(key);
1019     }
1020
1021     /**
1022      * Remove a keypress to be overridden for this window.
1023      *
1024      * @param key the key to stop taking control of
1025      */
1026     protected void removeShortcutKeypress(final TKeypress key) {
1027         keyboardShortcuts.remove(key);
1028     }
1029
1030     /**
1031      * Remove all keypresses to be overridden for this window.
1032      */
1033     protected void clearShortcutKeypresses() {
1034         keyboardShortcuts.clear();
1035     }
1036
1037     /**
1038      * Determine if a keypress is overridden for this window.
1039      *
1040      * @param key the key to check
1041      * @return true if this window wants to process this key on its own
1042      */
1043     public boolean isShortcutKeypress(final TKeypress key) {
1044         return keyboardShortcuts.contains(key);
1045     }
1046
1047     /**
1048      * Get the window's status bar, or null if it does not have one.
1049      *
1050      * @return the status bar, or null
1051      */
1052     public TStatusBar getStatusBar() {
1053         return statusBar;
1054     }
1055
1056     /**
1057      * Set the window's status bar to a new one.
1058      *
1059      * @param text the status bar text
1060      * @return the status bar
1061      */
1062     public TStatusBar newStatusBar(final String text) {
1063         statusBar = new TStatusBar(this, text);
1064         return statusBar;
1065     }
1066
1067     /**
1068      * Set the maximum width for this window.
1069      *
1070      * @param maximumWindowWidth new maximum width
1071      */
1072     public final void setMaximumWindowWidth(final int maximumWindowWidth) {
1073         if ((maximumWindowWidth != -1)
1074             && (maximumWindowWidth < minimumWindowWidth + 1)
1075         ) {
1076             throw new IllegalArgumentException("Maximum window width cannot " +
1077                 "be smaller than minimum window width + 1");
1078         }
1079         this.maximumWindowWidth = maximumWindowWidth;
1080     }
1081
1082     /**
1083      * Set the minimum width for this window.
1084      *
1085      * @param minimumWindowWidth new minimum width
1086      */
1087     public final void setMinimumWindowWidth(final int minimumWindowWidth) {
1088         if ((maximumWindowWidth != -1)
1089             && (minimumWindowWidth > maximumWindowWidth - 1)
1090         ) {
1091             throw new IllegalArgumentException("Minimum window width cannot " +
1092                 "be larger than maximum window width - 1");
1093         }
1094         this.minimumWindowWidth = minimumWindowWidth;
1095     }
1096
1097     /**
1098      * Set the maximum height for this window.
1099      *
1100      * @param maximumWindowHeight new maximum height
1101      */
1102     public final void setMaximumWindowHeight(final int maximumWindowHeight) {
1103         if ((maximumWindowHeight != -1)
1104             && (maximumWindowHeight < minimumWindowHeight + 1)
1105         ) {
1106             throw new IllegalArgumentException("Maximum window height cannot " +
1107                 "be smaller than minimum window height + 1");
1108         }
1109         this.maximumWindowHeight = maximumWindowHeight;
1110     }
1111
1112     /**
1113      * Set the minimum height for this window.
1114      *
1115      * @param minimumWindowHeight new minimum height
1116      */
1117     public final void setMinimumWindowHeight(final int minimumWindowHeight) {
1118         if ((maximumWindowHeight != -1)
1119             && (minimumWindowHeight > maximumWindowHeight - 1)
1120         ) {
1121             throw new IllegalArgumentException("Minimum window height cannot " +
1122                 "be larger than maximum window height - 1");
1123         }
1124         this.minimumWindowHeight = minimumWindowHeight;
1125     }
1126
1127     /**
1128      * Recenter the window on-screen.
1129      */
1130     public final void center() {
1131         if ((flags & CENTERED) != 0) {
1132             if (getWidth() < getScreen().getWidth()) {
1133                 setX((getScreen().getWidth() - getWidth()) / 2);
1134             } else {
1135                 setX(0);
1136             }
1137             setY(((application.getDesktopBottom()
1138                     - application.getDesktopTop()) - getHeight()) / 2);
1139             if (getY() < 0) {
1140                 setY(0);
1141             }
1142             setY(getY() + application.getDesktopTop());
1143         }
1144     }
1145
1146     /**
1147      * Maximize window.
1148      */
1149     public void maximize() {
1150         if (maximized) {
1151             return;
1152         }
1153
1154         restoreWindowWidth = getWidth();
1155         restoreWindowHeight = getHeight();
1156         restoreWindowX = getX();
1157         restoreWindowY = getY();
1158         setWidth(getScreen().getWidth());
1159         setHeight(application.getDesktopBottom() - application.getDesktopTop());
1160         setX(0);
1161         setY(application.getDesktopTop());
1162         maximized = true;
1163
1164         onResize(new TResizeEvent(TResizeEvent.Type.WIDGET, getWidth(),
1165                 getHeight()));
1166     }
1167
1168     /**
1169      * Restore (unmaximize) window.
1170      */
1171     public void restore() {
1172         if (!maximized) {
1173             return;
1174         }
1175
1176         setWidth(restoreWindowWidth);
1177         setHeight(restoreWindowHeight);
1178         setX(restoreWindowX);
1179         setY(restoreWindowY);
1180         maximized = false;
1181
1182         onResize(new TResizeEvent(TResizeEvent.Type.WIDGET, getWidth(),
1183                 getHeight()));
1184     }
1185
1186     /**
1187      * Returns true if this window is hidden.
1188      *
1189      * @return true if this window is hidden, false if the window is shown
1190      */
1191     public final boolean isHidden() {
1192         return hidden;
1193     }
1194
1195     /**
1196      * Returns true if this window is shown.
1197      *
1198      * @return true if this window is shown, false if the window is hidden
1199      */
1200     public final boolean isShown() {
1201         return !hidden;
1202     }
1203
1204     /**
1205      * Hide window.  A hidden window will still have its onIdle() called, and
1206      * will also have onClose() called at application exit.  Hidden windows
1207      * will not receive any other events.
1208      */
1209     public void hide() {
1210         application.hideWindow(this);
1211     }
1212
1213     /**
1214      * Show window.
1215      */
1216     public void show() {
1217         application.showWindow(this);
1218     }
1219
1220     /**
1221      * Activate window (bring to top and receive events).
1222      */
1223     @Override
1224     public void activate() {
1225         application.activateWindow(this);
1226     }
1227
1228     /**
1229      * Close window.  Note that windows without a close box can still be
1230      * closed by calling the close() method.
1231      */
1232     @Override
1233     public void close() {
1234         application.closeWindow(this);
1235     }
1236
1237     /**
1238      * See if this window is undergoing any movement/resize/etc.
1239      *
1240      * @return true if the window is moving
1241      */
1242     public boolean inMovements() {
1243         if (inWindowResize || inWindowMove || inKeyboardResize) {
1244             return true;
1245         }
1246         return false;
1247     }
1248
1249     /**
1250      * Stop any pending movement/resize/etc.
1251      */
1252     public void stopMovements() {
1253         inWindowResize = false;
1254         inWindowMove = false;
1255         inKeyboardResize = false;
1256     }
1257
1258     /**
1259      * Returns true if this window is modal.
1260      *
1261      * @return true if this window is modal
1262      */
1263     public final boolean isModal() {
1264         if ((flags & MODAL) == 0) {
1265             return false;
1266         }
1267         return true;
1268     }
1269
1270     /**
1271      * Returns true if this window has a close box.
1272      *
1273      * @return true if this window has a close box
1274      */
1275     public final boolean hasCloseBox() {
1276         if ((flags & NOCLOSEBOX) != 0) {
1277             return true;
1278         }
1279         return false;
1280     }
1281
1282     /**
1283      * Returns true if this window has a maximize/zoom box.
1284      *
1285      * @return true if this window has a maximize/zoom box
1286      */
1287     public final boolean hasZoomBox() {
1288         if ((flags & NOZOOMBOX) != 0) {
1289             return true;
1290         }
1291         return false;
1292     }
1293
1294     /**
1295      * Returns true if this window does not want menus to work while it is
1296      * visible.
1297      *
1298      * @return true if this window does not want menus to work while it is
1299      * visible
1300      */
1301     public final boolean hasOverriddenMenu() {
1302         if ((flags & OVERRIDEMENU) != 0) {
1303             return true;
1304         }
1305         return false;
1306     }
1307
1308     /**
1309      * Retrieve the background color.
1310      *
1311      * @return the background color
1312      */
1313     public CellAttributes getBackground() {
1314         if (!isModal()
1315             && (inWindowMove || inWindowResize || inKeyboardResize)
1316         ) {
1317             assert (isActive());
1318             return getTheme().getColor("twindow.background.windowmove");
1319         } else if (isModal() && inWindowMove) {
1320             assert (isActive());
1321             return getTheme().getColor("twindow.background.modal");
1322         } else if (isModal()) {
1323             if (isActive()) {
1324                 return getTheme().getColor("twindow.background.modal");
1325             }
1326             return getTheme().getColor("twindow.background.modal.inactive");
1327         } else if (isActive()) {
1328             assert (!isModal());
1329             return getTheme().getColor("twindow.background");
1330         } else {
1331             assert (!isModal());
1332             return getTheme().getColor("twindow.background.inactive");
1333         }
1334     }
1335
1336     /**
1337      * Retrieve the border color.
1338      *
1339      * @return the border color
1340      */
1341     public CellAttributes getBorder() {
1342         if (!isModal()
1343             && (inWindowMove || inWindowResize || inKeyboardResize)
1344         ) {
1345             if (!isActive()) {
1346                 // The user's terminal never passed a mouse up event, and now
1347                 // another window is active but we never finished a drag.
1348                 inWindowMove = false;
1349                 inWindowResize = false;
1350                 inKeyboardResize = false;
1351                 return getTheme().getColor("twindow.border.inactive");
1352             }
1353
1354             return getTheme().getColor("twindow.border.windowmove");
1355         } else if (isModal() && inWindowMove) {
1356             assert (isActive());
1357             return getTheme().getColor("twindow.border.modal.windowmove");
1358         } else if (isModal()) {
1359             if (isActive()) {
1360                 return getTheme().getColor("twindow.border.modal");
1361             } else {
1362                 return getTheme().getColor("twindow.border.modal.inactive");
1363             }
1364         } else if (isActive()) {
1365             assert (!isModal());
1366             return getTheme().getColor("twindow.border");
1367         } else {
1368             assert (!isModal());
1369             return getTheme().getColor("twindow.border.inactive");
1370         }
1371     }
1372
1373     /**
1374      * Retrieve the color used by the window movement/sizing controls.
1375      *
1376      * @return the color used by the zoom box, resize bar, and close box
1377      */
1378     public CellAttributes getBorderControls() {
1379         if (isModal()) {
1380             return getTheme().getColor("twindow.border.modal.windowmove");
1381         }
1382         return getTheme().getColor("twindow.border.windowmove");
1383     }
1384
1385     /**
1386      * Retrieve the border line type.
1387      *
1388      * @return the border line type
1389      */
1390     private int getBorderType() {
1391         if (!isModal()
1392             && (inWindowMove || inWindowResize || inKeyboardResize)
1393         ) {
1394             assert (isActive());
1395             return 1;
1396         } else if (isModal() && inWindowMove) {
1397             assert (isActive());
1398             return 1;
1399         } else if (isModal()) {
1400             if (isActive()) {
1401                 return 2;
1402             } else {
1403                 return 1;
1404             }
1405         } else if (isActive()) {
1406             return 2;
1407         } else {
1408             return 1;
1409         }
1410     }
1411
1412     /**
1413      * Returns true if this window does not want the application-wide mouse
1414      * cursor drawn over it.
1415      *
1416      * @return true if this window does not want the application-wide mouse
1417      * cursor drawn over it
1418      */
1419     public boolean hasHiddenMouse() {
1420         return hideMouse;
1421     }
1422
1423     /**
1424      * Set request to prevent the application-wide mouse cursor from being
1425      * drawn over this window.
1426      *
1427      * @param hideMouse if true, this window does not want the
1428      * application-wide mouse cursor drawn over it
1429      */
1430     public final void setHiddenMouse(final boolean hideMouse) {
1431         this.hideMouse = hideMouse;
1432     }
1433
1434 }