smart window placement
[fanfix.git] / src / jexer / menu / TMenu.java
index 6dfb5fcfabe71f2f1d961572c0a877045b0e85a2..6d89647a6f459c9eb35df1badd79ee14ceccdb7e 100644 (file)
@@ -1,29 +1,27 @@
 /*
  * Jexer - Java Text User Interface
  *
- * License: LGPLv3 or later
+ * The MIT License (MIT)
  *
- * 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.
+ * Copyright (C) 2016 Kevin Lamonte
  *
- *     Copyright (C) 2015  Kevin Lamonte
+ * 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 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.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
  *
- * 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.
- *
- * 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
@@ -90,6 +88,15 @@ public final class TMenu extends TWindow {
     public static final int MID_WINDOW_PREVIOUS = 26;
     public static final int MID_WINDOW_CLOSE    = 27;
 
+    // Help menu
+    public static final int MID_HELP_CONTENTS           = 40;
+    public static final int MID_HELP_INDEX              = 41;
+    public static final int MID_HELP_SEARCH             = 42;
+    public static final int MID_HELP_PREVIOUS           = 43;
+    public static final int MID_HELP_HELP               = 44;
+    public static final int MID_HELP_ACTIVE_FILE        = 45;
+    public static final int MID_ABOUT                   = 46;
+
     /**
      * Public constructor.
      *
@@ -106,9 +113,6 @@ public final class TMenu extends TWindow {
         super(parent, label, x, y, parent.getScreen().getWidth(),
             parent.getScreen().getHeight());
 
-        // My parent constructor added me as a window, get rid of that
-        parent.closeWindow(this);
-
         // Setup the menu shortcut
         mnemonic = new MnemonicString(label);
         setTitle(mnemonic.getRawLabel());
@@ -315,7 +319,7 @@ public final class TMenu extends TWindow {
      * @param label menu item label
      * @return the new menu item
      */
-    public final TMenuItem addItem(final int id, final String label) {
+    public TMenuItem addItem(final int id, final String label) {
         assert (id >= 1024);
         return addItemInternal(id, label, null);
     }
@@ -328,7 +332,7 @@ public final class TMenu extends TWindow {
      * @param key global keyboard accelerator
      * @return the new menu item
      */
-    public final TMenuItem addItem(final int id, final String label,
+    public TMenuItem addItem(final int id, final String label,
         final TKeypress key) {
 
         assert (id >= 1024);
@@ -371,7 +375,7 @@ public final class TMenu extends TWindow {
      * (inclusive).
      * @return the new menu item
      */
-    public final TMenuItem addDefaultItem(final int id) {
+    public TMenuItem addDefaultItem(final int id) {
         assert (id >= 0);
         assert (id < 1024);
 
@@ -438,7 +442,32 @@ public final class TMenu extends TWindow {
             break;
         case MID_WINDOW_CLOSE:
             label = "&Close";
-            // key = kbCtrlW;
+            key = kbCtrlW;
+            break;
+
+        case MID_HELP_CONTENTS:
+            label = "&Contents";
+            break;
+        case MID_HELP_INDEX:
+            label = "&Index";
+            key = kbShiftF1;
+            break;
+        case MID_HELP_SEARCH:
+            label = "&Topic search";
+            key = kbCtrlF1;
+            break;
+        case MID_HELP_PREVIOUS:
+            label = "&Previous topic";
+            key = kbAltF1;
+            break;
+        case MID_HELP_HELP:
+            label = "&Help on help";
+            break;
+        case MID_HELP_ACTIVE_FILE:
+            label = "Active &file...";
+            break;
+        case MID_ABOUT:
+            label = "&About...";
             break;
 
         default:
@@ -451,7 +480,7 @@ public final class TMenu extends TWindow {
     /**
      * Convenience function to add a menu separator.
      */
-    public final void addSeparator() {
+    public void addSeparator() {
         int newY = getChildren().size() + 1;
         assert (newY < getHeight());
 
@@ -468,7 +497,7 @@ public final class TMenu extends TWindow {
      * denoted by prefixing a letter with "&", e.g. "&File"
      * @return the new sub-menu
      */
-    public final TSubMenu addSubMenu(final String title) {
+    public TSubMenu addSubMenu(final String title) {
         int newY = getChildren().size() + 1;
         assert (newY < getHeight());