LICENSE CHANGED TO MIT
[nikiroo-utils.git] / src / jexer / TApplication.java
index 1b928dd8442dae3e851a64e91bc8bbd8ee115b4f..f4cf2d5cb7a54a800c421e21b854b8552247725a 100644 (file)
@@ -1,29 +1,27 @@
-/**
+/*
  * Jexer - Java Text User Interface
  *
- * License: LGPLv3 or later
- *
- * This module is licensed under the GNU Lesser General Public License
- * Version 3.  Please see the file "COPYING" in this directory for more
- * information about the GNU Lesser General Public License Version 3.
+ * The MIT License (MIT)
  *
- *     Copyright (C) 2015  Kevin Lamonte
+ * Copyright (C) 2016 Kevin Lamonte
  *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 3 of
- * the License, or (at your option) any later version.
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
  *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
  *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, see
- * http://www.gnu.org/licenses/, or write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- * 02110-1301 USA
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
  *
  * @author Kevin Lamonte [kevin.lamonte@gmail.com]
  * @version 1
@@ -89,7 +87,7 @@ public class TApplication implements Runnable {
         ECMA48,
 
         /**
-         * Synonym for ECMA48
+         * Synonym for ECMA48.
          */
         XTERM
     }
@@ -430,6 +428,11 @@ public class TApplication implements Runnable {
      */
     private Map<TKeypress, TMenuItem> accelerators;
 
+    /**
+     * All menu items.
+     */
+    private List<TMenuItem> menuItems;
+
     /**
      * Windows and widgets pull colors from this ColorTheme.
      */
@@ -513,6 +516,10 @@ public class TApplication implements Runnable {
             // Fall through...
         case ECMA48:
             backend = new ECMA48Backend(this, null, null);
+            break;
+        default:
+            throw new IllegalArgumentException("Invalid backend type: "
+                + backendType);
         }
         TApplicationImpl();
     }
@@ -561,6 +568,7 @@ public class TApplication implements Runnable {
         subMenus        = new LinkedList<TMenu>();
         timers          = new LinkedList<TTimer>();
         accelerators    = new HashMap<TKeypress, TMenuItem>();
+        menuItems       = new ArrayList<TMenuItem>();
 
         // Setup the main consumer thread
         primaryEventHandler = new WidgetEventHandler(this, true);
@@ -997,7 +1005,7 @@ public class TApplication implements Runnable {
         // secondary thread locks again.  When it gives up, we have the
         // single lock back.
         boolean oldLock = unlockHandleEvent();
-        assert (oldLock == true);
+        assert (oldLock);
 
         while (secondaryEventReceiver != null) {
             synchronized (primaryEventHandler) {
@@ -1075,6 +1083,7 @@ public class TApplication implements Runnable {
         synchronized (windows) {
             int z = window.getZ();
             window.setZ(-1);
+            window.onUnfocus();
             Collections.sort(windows);
             windows.remove(0);
             TWindow activeWindow = null;
@@ -1083,10 +1092,14 @@ public class TApplication implements Runnable {
                     w.setZ(w.getZ() - 1);
                     if (w.getZ() == 0) {
                         w.setActive(true);
+                        w.onFocus();
                         assert (activeWindow == null);
                         activeWindow = w;
                     } else {
-                        w.setActive(false);
+                        if (w.isActive()) {
+                            w.setActive(false);
+                            w.onUnfocus();
+                        }
                     }
                 }
             }
@@ -1152,8 +1165,10 @@ public class TApplication implements Runnable {
             }
             windows.get(activeWindowI).setActive(false);
             windows.get(activeWindowI).setZ(windows.get(nextWindowI).getZ());
+            windows.get(activeWindowI).onUnfocus();
             windows.get(nextWindowI).setZ(0);
             windows.get(nextWindowI).setActive(true);
+            windows.get(nextWindowI).onFocus();
 
         } // synchronized (windows)
 
@@ -1171,12 +1186,16 @@ public class TApplication implements Runnable {
                 assert (window.isModal());
             }
             for (TWindow w: windows) {
-                w.setActive(false);
+                if (w.isActive()) {
+                    w.setActive(false);
+                    w.onUnfocus();
+                }
                 w.setZ(w.getZ() + 1);
             }
             windows.add(window);
-            window.setActive(true);
             window.setZ(0);
+            window.setActive(true);
+            window.onFocus();
         }
     }
 
@@ -1320,10 +1339,12 @@ public class TApplication implements Runnable {
                     // We will be switching to another window
                     assert (windows.get(0).isActive());
                     assert (!window.isActive());
+                    windows.get(0).onUnfocus();
                     windows.get(0).setActive(false);
                     windows.get(0).setZ(window.getZ());
                     window.setZ(0);
                     window.setActive(true);
+                    window.onFocus();
                     return;
                 }
             }
@@ -1500,17 +1521,76 @@ public class TApplication implements Runnable {
     }
 
     /**
-     * Add a keyboard accelerator to the global hash.
+     * Add a menu item to the global list.  If it has a keyboard accelerator,
+     * that will be added the global hash.
+     *
+     * @param item the menu item
+     */
+    public final void addMenuItem(final TMenuItem item) {
+        menuItems.add(item);
+
+        TKeypress key = item.getKey();
+        if (key != null) {
+            synchronized (accelerators) {
+                assert (accelerators.get(key) == null);
+                accelerators.put(key.toLowerCase(), item);
+            }
+        }
+    }
+
+    /**
+     * Disable one menu item.
+     *
+     * @param id the menu item ID
+     */
+    public final void disableMenuItem(final int id) {
+        for (TMenuItem item: menuItems) {
+            if (item.getId() == id) {
+                item.setEnabled(false);
+            }
+        }
+    }
+
+    /**
+     * Disable the range of menu items with ID's between lower and upper,
+     * inclusive.
+     *
+     * @param lower the lowest menu item ID
+     * @param upper the highest menu item ID
+     */
+    public final void disableMenuItems(final int lower, final int upper) {
+        for (TMenuItem item: menuItems) {
+            if ((item.getId() >= lower) && (item.getId() <= upper)) {
+                item.setEnabled(false);
+            }
+        }
+    }
+
+    /**
+     * Enable one menu item.
      *
-     * @param item menu item this accelerator relates to
-     * @param keypress keypress that will dispatch a TMenuEvent
+     * @param id the menu item ID
      */
-    public final void addAccelerator(final TMenuItem item,
-        final TKeypress keypress) {
+    public final void enableMenuItem(final int id) {
+        for (TMenuItem item: menuItems) {
+            if (item.getId() == id) {
+                item.setEnabled(true);
+            }
+        }
+    }
 
-        synchronized (accelerators) {
-            assert (accelerators.get(keypress) == null);
-            accelerators.put(keypress, item);
+    /**
+     * Enable the range of menu items with ID's between lower and upper,
+     * inclusive.
+     *
+     * @param lower the lowest menu item ID
+     * @param upper the highest menu item ID
+     */
+    public final void enableMenuItems(final int lower, final int upper) {
+        for (TMenuItem item: menuItems) {
+            if ((item.getId() >= lower) && (item.getId() <= upper)) {
+                item.setEnabled(true);
+            }
         }
     }
 
@@ -1827,6 +1907,7 @@ public class TApplication implements Runnable {
      *
      * @param path path of selected file
      * @return the result of the new file open box
+     * @throws IOException if java.io operation throws
      */
     public final String fileOpenBox(final String path) throws IOException {
 
@@ -1840,6 +1921,7 @@ public class TApplication implements Runnable {
      * @param path path of selected file
      * @param type one of the Type constants
      * @return the result of the new file open box
+     * @throws IOException if java.io operation throws
      */
     public final String fileOpenBox(final String path,
         final TFileOpenBox.Type type) throws IOException {