Merge commit '77d3a60869e7a780c6ae069e51530e1eacece5e2'
[fanfix.git] / src / jexer / menu / TMenu.java
index be4cf5dd12646bd107d7841a3dc49edd15996cd9..6a875c7c8377f154e9cafb07b064cde7ab889d3d 100644 (file)
@@ -3,7 +3,7 @@
  *
  * The MIT License (MIT)
  *
- * Copyright (C) 2017 Kevin Lamonte
+ * Copyright (C) 2019 Kevin Lamonte
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the "Software"),
@@ -37,6 +37,7 @@ import jexer.TWindow;
 import jexer.bits.CellAttributes;
 import jexer.bits.GraphicsChars;
 import jexer.bits.MnemonicString;
+import jexer.bits.StringUtils;
 import jexer.event.TKeypressEvent;
 import jexer.event.TMouseEvent;
 import static jexer.TKeypress.*;
@@ -44,7 +45,7 @@ import static jexer.TKeypress.*;
 /**
  * TMenu is a top-level collection of TMenuItems.
  */
-public final class TMenu extends TWindow {
+public class TMenu extends TWindow {
 
     /**
      * Translated strings.
@@ -58,45 +59,81 @@ public final class TMenu extends TWindow {
     // Reserved menu item IDs
     public static final int MID_UNUSED          = -1;
 
+    // Tools menu
+    public static final int MID_REPAINT         = 1;
+    public static final int MID_VIEW_IMAGE      = 2;
+    public static final int MID_SCREEN_OPTIONS  = 3;
+
     // File menu
-    public static final int MID_EXIT            = 1;
+    public static final int MID_NEW             = 10;
+    public static final int MID_EXIT            = 11;
     public static final int MID_QUIT            = MID_EXIT;
-    public static final int MID_OPEN_FILE       = 2;
-    public static final int MID_SHELL           = 3;
+    public static final int MID_OPEN_FILE       = 12;
+    public static final int MID_SHELL           = 13;
 
     // Edit menu
-    public static final int MID_CUT             = 10;
-    public static final int MID_COPY            = 11;
-    public static final int MID_PASTE           = 12;
-    public static final int MID_CLEAR           = 13;
+    public static final int MID_UNDO            = 20;
+    public static final int MID_REDO            = 21;
+    public static final int MID_CUT             = 22;
+    public static final int MID_COPY            = 23;
+    public static final int MID_PASTE           = 24;
+    public static final int MID_CLEAR           = 25;
 
     // Search menu
-    public static final int MID_FIND            = 20;
-    public static final int MID_REPLACE         = 21;
-    public static final int MID_SEARCH_AGAIN    = 22;
-    public static final int MID_GOTO_LINE       = 23;
+    public static final int MID_FIND            = 30;
+    public static final int MID_REPLACE         = 31;
+    public static final int MID_SEARCH_AGAIN    = 32;
+    public static final int MID_GOTO_LINE       = 33;
 
     // Window menu
-    public static final int MID_TILE            = 30;
-    public static final int MID_CASCADE         = 31;
-    public static final int MID_CLOSE_ALL       = 32;
-    public static final int MID_WINDOW_MOVE     = 33;
-    public static final int MID_WINDOW_ZOOM     = 34;
-    public static final int MID_WINDOW_NEXT     = 35;
-    public static final int MID_WINDOW_PREVIOUS = 36;
-    public static final int MID_WINDOW_CLOSE    = 37;
+    public static final int MID_TILE            = 40;
+    public static final int MID_CASCADE         = 41;
+    public static final int MID_CLOSE_ALL       = 42;
+    public static final int MID_WINDOW_MOVE     = 43;
+    public static final int MID_WINDOW_ZOOM     = 44;
+    public static final int MID_WINDOW_NEXT     = 45;
+    public static final int MID_WINDOW_PREVIOUS = 46;
+    public static final int MID_WINDOW_CLOSE    = 47;
 
     // 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;
-
-    // Other
-    public static final int MID_REPAINT         = 50;
+    public static final int MID_HELP_CONTENTS           = 50;
+    public static final int MID_HELP_INDEX              = 51;
+    public static final int MID_HELP_SEARCH             = 52;
+    public static final int MID_HELP_PREVIOUS           = 53;
+    public static final int MID_HELP_HELP               = 54;
+    public static final int MID_HELP_ACTIVE_FILE        = 55;
+    public static final int MID_ABOUT                   = 56;
+
+    // Table menu
+    public static final int MID_TABLE_RENAME_ROW                = 60;
+    public static final int MID_TABLE_RENAME_COLUMN             = 61;
+    public static final int MID_TABLE_VIEW_ROW_LABELS           = 70;
+    public static final int MID_TABLE_VIEW_COLUMN_LABELS        = 71;
+    public static final int MID_TABLE_VIEW_HIGHLIGHT_ROW        = 72;
+    public static final int MID_TABLE_VIEW_HIGHLIGHT_COLUMN     = 73;
+    public static final int MID_TABLE_BORDER_NONE               = 80;
+    public static final int MID_TABLE_BORDER_ALL                = 81;
+    public static final int MID_TABLE_BORDER_CELL_NONE          = 82;
+    public static final int MID_TABLE_BORDER_CELL_ALL           = 83;
+    public static final int MID_TABLE_BORDER_RIGHT              = 84;
+    public static final int MID_TABLE_BORDER_LEFT               = 85;
+    public static final int MID_TABLE_BORDER_TOP                = 86;
+    public static final int MID_TABLE_BORDER_BOTTOM             = 87;
+    public static final int MID_TABLE_BORDER_DOUBLE_BOTTOM      = 88;
+    public static final int MID_TABLE_BORDER_THICK_BOTTOM       = 89;
+    public static final int MID_TABLE_DELETE_LEFT               = 100;
+    public static final int MID_TABLE_DELETE_UP                 = 101;
+    public static final int MID_TABLE_DELETE_ROW                = 102;
+    public static final int MID_TABLE_DELETE_COLUMN             = 103;
+    public static final int MID_TABLE_INSERT_LEFT               = 104;
+    public static final int MID_TABLE_INSERT_RIGHT              = 105;
+    public static final int MID_TABLE_INSERT_ABOVE              = 106;
+    public static final int MID_TABLE_INSERT_BELOW              = 107;
+    public static final int MID_TABLE_COLUMN_NARROW             = 110;
+    public static final int MID_TABLE_COLUMN_WIDEN              = 111;
+    public static final int MID_TABLE_FILE_OPEN_CSV             = 115;
+    public static final int MID_TABLE_FILE_SAVE_CSV             = 116;
+    public static final int MID_TABLE_FILE_SAVE_TEXT            = 117;
 
     // ------------------------------------------------------------------------
     // Variables --------------------------------------------------------------
@@ -117,6 +154,11 @@ public final class TMenu extends TWindow {
      */
     private MnemonicString mnemonic;
 
+    /**
+     * If true, draw icons with menu items.  Note package private access.
+     */
+    boolean useIcons = false;
+
     // ------------------------------------------------------------------------
     // Constructors -----------------------------------------------------------
     // ------------------------------------------------------------------------
@@ -128,8 +170,8 @@ public final class TMenu extends TWindow {
      * @param x column relative to parent
      * @param y row relative to parent
      * @param label mnemonic menu title.  Label must contain a keyboard
-     * shortcut (mnemonic), denoted by prefixing a letter with "&",
-     * e.g. "&File"
+     * shortcut (mnemonic), denoted by prefixing a letter with "&",
+     * e.g. "&File"
      */
     public TMenu(final TApplication parent, final int x, final int y,
         final String label) {
@@ -143,10 +185,15 @@ public final class TMenu extends TWindow {
         assert (mnemonic.getShortcutIdx() >= 0);
 
         // Recompute width and height to reflect an empty menu
-        setWidth(getTitle().length() + 4);
+        setWidth(StringUtils.width(getTitle()) + 4);
         setHeight(2);
 
         setActive(false);
+
+        if (System.getProperty("jexer.menuIcons", "false").equals("true")) {
+            useIcons = true;
+        }
+
     }
 
     // ------------------------------------------------------------------------
@@ -161,6 +208,7 @@ public final class TMenu extends TWindow {
     @Override
     public void onMouseDown(final TMouseEvent mouse) {
         this.mouse = mouse;
+        super.onMouseDown(mouse);
 
         // Pass to children
         for (TWidget widget: getChildren()) {
@@ -236,15 +284,21 @@ public final class TMenu extends TWindow {
         /*
         System.err.printf("keypress: %s active child: %s\n", keypress,
             getActiveChild());
-         */
+        */
 
         if (getActiveChild() != this) {
-            if ((getActiveChild() instanceof TSubMenu)
-                || (getActiveChild() instanceof TMenu)
-            ) {
+            if (getActiveChild() instanceof TMenu) {
                 getActiveChild().onKeypress(keypress);
                 return;
             }
+
+            if (getActiveChild() instanceof TSubMenu) {
+                TSubMenu subMenu = (TSubMenu) getActiveChild();
+                if (subMenu.menu.isActive()) {
+                    subMenu.onKeypress(keypress);
+                    return;
+                }
+            }
         }
 
         if (keypress.equals(kbEsc)) {
@@ -276,12 +330,18 @@ public final class TMenu extends TWindow {
         if (!keypress.getKey().isFnKey()
             && !keypress.getKey().isAlt()
             && !keypress.getKey().isCtrl()) {
+
+            // System.err.println("Checking children for mnemonic...");
+
             for (TWidget widget: getChildren()) {
                 TMenuItem item = (TMenuItem) widget;
-                if ((item.getMnemonic() != null)
+                if ((item.isEnabled() == true)
+                    && (item.getMnemonic() != null)
                     && (Character.toLowerCase(item.getMnemonic().getShortcut())
                         == Character.toLowerCase(keypress.getKey().getChar()))
                 ) {
+                    // System.err.println("activate: " + item);
+
                     // Send an enter keystroke to it
                     activate(item);
                     item.handleEvent(new TKeypressEvent(kbEnter));
@@ -341,7 +401,7 @@ public final class TMenu extends TWindow {
         hLineXY(1 + 1, getHeight() - 1, getWidth() - 4, cHSide, background);
 
         // Draw a shadow
-        getScreen().drawBoxShadow(0, 0, getWidth(), getHeight());
+        drawBoxShadow(0, 0, getWidth(), getHeight());
     }
 
     // ------------------------------------------------------------------------
@@ -383,10 +443,24 @@ public final class TMenu extends TWindow {
      * @return the new menu item
      */
     public TMenuItem addItem(final int id, final String label) {
-        assert (id >= 1024);
         return addItemInternal(id, label, null);
     }
 
+    /**
+     * Convenience function to add a menu item.
+     *
+     * @param id menu item ID.  Must be greater than 1024.
+     * @param label menu item label
+     * @param enabled default state for enabled
+     * @return the new menu item
+     */
+    public TMenuItem addItem(final int id, final String label,
+        final boolean enabled) {
+
+        assert (id >= 1024);
+        return addItemInternal(id, label, null, enabled, -1);
+    }
+
     /**
      * Convenience function to add a custom menu item.
      *
@@ -430,7 +504,7 @@ public final class TMenu extends TWindow {
     private TMenuItem addItemInternal(final int id, final String label,
         final TKeypress key) {
 
-        return addItemInternal(id, label, key, true);
+        return addItemInternal(id, label, key, true, -1);
     }
 
     /**
@@ -440,15 +514,16 @@ public final class TMenu extends TWindow {
      * @param label menu item label
      * @param key global keyboard accelerator
      * @param enabled default state for enabled
+     * @param icon icon picture/emoji
      * @return the new menu item
      */
     private TMenuItem addItemInternal(final int id, final String label,
-        final TKeypress key, final boolean enabled) {
+        final TKeypress key, final boolean enabled, final int icon) {
 
         int newY = getChildren().size() + 1;
         assert (newY < getHeight());
 
-        TMenuItem menuItem = new TMenuItem(this, id, 1, newY, label);
+        TMenuItem menuItem = new TMenuItem(this, id, 1, newY, label, icon);
         menuItem.setKey(key);
         menuItem.setEnabled(enabled);
         setHeight(getHeight() + 1);
@@ -489,52 +564,87 @@ public final class TMenu extends TWindow {
 
         String label;
         TKeypress key = null;
+        int icon = -1;
+        boolean checkable = false;
+        boolean checked = false;
 
         switch (id) {
 
+        case MID_REPAINT:
+            label = i18n.getString("menuRepaintDesktop");
+            icon = 0x1F3A8;
+            break;
+
+        case MID_VIEW_IMAGE:
+            label = i18n.getString("menuViewImage");
+            break;
+
+        case MID_SCREEN_OPTIONS:
+            label = i18n.getString("menuScreenOptions");
+            break;
+
+        case MID_NEW:
+            label = i18n.getString("menuNew");
+            icon = 0x1F5CE;
+            break;
+
         case MID_EXIT:
             label = i18n.getString("menuExit");
             key = kbAltX;
+            icon = 0x1F5D9;
             break;
 
         case MID_SHELL:
             label = i18n.getString("menuShell");
+            icon = 0x1F5AE;
             break;
 
         case MID_OPEN_FILE:
             label = i18n.getString("menuOpen");
             key = kbF3;
+            icon = 0x1F5C1;
             break;
 
+        case MID_UNDO:
+            label = i18n.getString("menuUndo");
+            key = kbCtrlZ;
+            break;
+        case MID_REDO:
+            label = i18n.getString("menuRedo");
+            key = kbCtrlY;
+            break;
         case MID_CUT:
             label = i18n.getString("menuCut");
             key = kbCtrlX;
+            icon = 0x1F5F6;
             break;
         case MID_COPY:
             label = i18n.getString("menuCopy");
             key = kbCtrlC;
+            icon = 0x1F5D0;
             break;
         case MID_PASTE:
             label = i18n.getString("menuPaste");
             key = kbCtrlV;
+            icon = 0x1F4CB;
             break;
         case MID_CLEAR:
             label = i18n.getString("menuClear");
-            // key = kbDel;
             break;
 
         case MID_FIND:
             label = i18n.getString("menuFind");
+            icon = 0x1F50D;
             break;
         case MID_REPLACE:
             label = i18n.getString("menuReplace");
             break;
         case MID_SEARCH_AGAIN:
             label = i18n.getString("menuSearchAgain");
+            key = kbCtrlL;
             break;
         case MID_GOTO_LINE:
             label = i18n.getString("menuGotoLine");
-            key = kbCtrlL;
             break;
 
         case MID_TILE:
@@ -542,6 +652,7 @@ public final class TMenu extends TWindow {
             break;
         case MID_CASCADE:
             label = i18n.getString("menuWindowCascade");
+            icon = 0x1F5D7;
             break;
         case MID_CLOSE_ALL:
             label = i18n.getString("menuWindowCloseAll");
@@ -549,18 +660,22 @@ public final class TMenu extends TWindow {
         case MID_WINDOW_MOVE:
             label = i18n.getString("menuWindowMove");
             key = kbCtrlF5;
+            icon = 0x263C;
             break;
         case MID_WINDOW_ZOOM:
             label = i18n.getString("menuWindowZoom");
             key = kbF5;
+            icon = 0x2195;
             break;
         case MID_WINDOW_NEXT:
             label = i18n.getString("menuWindowNext");
             key = kbF6;
+            icon = 0x2192;
             break;
         case MID_WINDOW_PREVIOUS:
             label = i18n.getString("menuWindowPrevious");
             key = kbShiftF6;
+            icon = 0x2190;
             break;
         case MID_WINDOW_CLOSE:
             label = i18n.getString("menuWindowClose");
@@ -592,15 +707,112 @@ public final class TMenu extends TWindow {
             label = i18n.getString("menuHelpAbout");
             break;
 
-        case MID_REPAINT:
-            label = i18n.getString("menuRepaintDesktop");
+        case MID_TABLE_RENAME_COLUMN:
+            label = i18n.getString("menuTableRenameColumn");
+            break;
+        case MID_TABLE_RENAME_ROW:
+            label = i18n.getString("menuTableRenameRow");
+            break;
+        case MID_TABLE_VIEW_ROW_LABELS:
+            label = i18n.getString("menuTableViewRowLabels");
+            checkable = true;
+            checked = true;
+            break;
+        case MID_TABLE_VIEW_COLUMN_LABELS:
+            label = i18n.getString("menuTableViewColumnLabels");
+            checkable = true;
+            checked = true;
+            break;
+        case MID_TABLE_VIEW_HIGHLIGHT_ROW:
+            label = i18n.getString("menuTableViewHighlightRow");
+            checkable = true;
+            checked = true;
+            break;
+        case MID_TABLE_VIEW_HIGHLIGHT_COLUMN:
+            label = i18n.getString("menuTableViewHighlightColumn");
+            checkable = true;
+            checked = true;
+            break;
+
+        case MID_TABLE_BORDER_NONE:
+            label = i18n.getString("menuTableBorderNone");
+            break;
+        case MID_TABLE_BORDER_ALL:
+            label = i18n.getString("menuTableBorderAll");
+            break;
+        case MID_TABLE_BORDER_CELL_NONE:
+            label = i18n.getString("menuTableBorderCellNone");
+            break;
+        case MID_TABLE_BORDER_CELL_ALL:
+            label = i18n.getString("menuTableBorderCellAll");
+            break;
+        case MID_TABLE_BORDER_RIGHT:
+            label = i18n.getString("menuTableBorderRight");
+            break;
+        case MID_TABLE_BORDER_LEFT:
+            label = i18n.getString("menuTableBorderLeft");
+            break;
+        case MID_TABLE_BORDER_TOP:
+            label = i18n.getString("menuTableBorderTop");
+            break;
+        case MID_TABLE_BORDER_BOTTOM:
+            label = i18n.getString("menuTableBorderBottom");
+            break;
+        case MID_TABLE_BORDER_DOUBLE_BOTTOM:
+            label = i18n.getString("menuTableBorderDoubleBottom");
+            break;
+        case MID_TABLE_BORDER_THICK_BOTTOM:
+            label = i18n.getString("menuTableBorderThickBottom");
+            break;
+        case MID_TABLE_DELETE_LEFT:
+            label = i18n.getString("menuTableDeleteLeft");
+            break;
+        case MID_TABLE_DELETE_UP:
+            label = i18n.getString("menuTableDeleteUp");
+            break;
+        case MID_TABLE_DELETE_ROW:
+            label = i18n.getString("menuTableDeleteRow");
+            break;
+        case MID_TABLE_DELETE_COLUMN:
+            label = i18n.getString("menuTableDeleteColumn");
+            break;
+        case MID_TABLE_INSERT_LEFT:
+            label = i18n.getString("menuTableInsertLeft");
+            break;
+        case MID_TABLE_INSERT_RIGHT:
+            label = i18n.getString("menuTableInsertRight");
+            break;
+        case MID_TABLE_INSERT_ABOVE:
+            label = i18n.getString("menuTableInsertAbove");
+            break;
+        case MID_TABLE_INSERT_BELOW:
+            label = i18n.getString("menuTableInsertBelow");
+            break;
+        case MID_TABLE_COLUMN_NARROW:
+            label = i18n.getString("menuTableColumnNarrow");
+            key = kbShiftLeft;
+            break;
+        case MID_TABLE_COLUMN_WIDEN:
+            label = i18n.getString("menuTableColumnWiden");
+            key = kbShiftRight;
+            break;
+        case MID_TABLE_FILE_OPEN_CSV:
+            label = i18n.getString("menuTableFileOpenCsv");
+            break;
+        case MID_TABLE_FILE_SAVE_CSV:
+            label = i18n.getString("menuTableFileSaveCsv");
+            break;
+        case MID_TABLE_FILE_SAVE_TEXT:
+            label = i18n.getString("menuTableFileSaveText");
             break;
 
         default:
             throw new IllegalArgumentException("Invalid menu ID: " + id);
         }
 
-        return addItemInternal(id, label, key, enabled);
+        TMenuItem item = addItemInternal(id, label, key, enabled, icon);
+        item.setCheckable(checkable);
+        return item;
     }
 
     /**
@@ -620,7 +832,7 @@ public final class TMenu extends TWindow {
      * Convenience function to add a sub-menu.
      *
      * @param title menu title.  Title must contain a keyboard shortcut,
-     * denoted by prefixing a letter with "&", e.g. "&File"
+     * denoted by prefixing a letter with "&amp;", e.g. "&amp;File"
      * @return the new sub-menu
      */
     public TSubMenu addSubMenu(final String title) {