Add 'src/jexer/' from commit 'cf01c92f5809a0732409e280fb0f32f27393618d'
[fanfix.git] / src / jexer / menu / TMenuItem.java
index fe74c4e7f8b837dfc361c4a697b0e0610e470ab0..d9dfc2ac5482b64123713f45e8b58f7f9abf3e3d 100644 (file)
@@ -3,7 +3,7 @@
  *
  * The MIT License (MIT)
  *
- * Copyright (C) 2016 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"),
@@ -33,6 +33,7 @@ import jexer.TWidget;
 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 jexer.event.TMenuEvent;
@@ -43,6 +44,10 @@ import static jexer.TKeypress.*;
  */
 public class TMenuItem extends TWidget {
 
+    // ------------------------------------------------------------------------
+    // Variables --------------------------------------------------------------
+    // ------------------------------------------------------------------------
+
     /**
      * Label for this menu item.
      */
@@ -54,29 +59,11 @@ public class TMenuItem extends TWidget {
      */
     private int id = TMenu.MID_UNUSED;
 
-    /**
-     * Get the menu item ID.
-     *
-     * @return the id
-     */
-    public final int getId() {
-        return id;
-    }
-
     /**
      * When true, this item can be checked or unchecked.
      */
     private boolean checkable = false;
 
-    /**
-     * Set checkable flag.
-     *
-     * @param checkable if true, this menu item can be checked/unchecked
-     */
-    public final void setCheckable(final boolean checkable) {
-        this.checkable = checkable;
-    }
-
     /**
      * When true, this item is checked.
      */
@@ -93,40 +80,9 @@ public class TMenuItem extends TWidget {
      */
     private MnemonicString mnemonic;
 
-    /**
-     * Get the mnemonic string for this menu item.
-     *
-     * @return mnemonic string
-     */
-    public final MnemonicString getMnemonic() {
-        return mnemonic;
-    }
-
-    /**
-     * Get a global accelerator key for this menu item.
-     *
-     * @return global keyboard accelerator, or null if no key is associated
-     * with this item
-     */
-    public final TKeypress getKey() {
-        return key;
-    }
-
-    /**
-     * Set a global accelerator key for this menu item.
-     *
-     * @param key global keyboard accelerator
-     */
-    public final void setKey(final TKeypress key) {
-        this.key = key;
-
-        if (key != null) {
-            int newWidth = (label.length() + 4 + key.toString().length() + 2);
-            if (newWidth > getWidth()) {
-                setWidth(newWidth);
-            }
-        }
-    }
+    // ------------------------------------------------------------------------
+    // Constructors -----------------------------------------------------------
+    // ------------------------------------------------------------------------
 
     /**
      * Package private constructor.
@@ -149,7 +105,7 @@ public class TMenuItem extends TWidget {
         setY(y);
         setHeight(1);
         this.label = mnemonic.getRawLabel();
-        setWidth(label.length() + 4);
+        setWidth(StringUtils.width(label) + 4);
         this.id = id;
 
         // Default state for some known menu items
@@ -190,6 +146,10 @@ public class TMenuItem extends TWidget {
 
     }
 
+    // ------------------------------------------------------------------------
+    // Event handlers ---------------------------------------------------------
+    // ------------------------------------------------------------------------
+
     /**
      * Returns true if the mouse is currently on the menu item.
      *
@@ -206,6 +166,39 @@ public class TMenuItem extends TWidget {
         return false;
     }
 
+    /**
+     * Handle mouse button releases.
+     *
+     * @param mouse mouse button release event
+     */
+    @Override
+    public void onMouseUp(final TMouseEvent mouse) {
+        if ((mouseOnMenuItem(mouse)) && (mouse.isMouse1())) {
+            dispatch();
+            return;
+        }
+    }
+
+    /**
+     * Handle keystrokes.
+     *
+     * @param keypress keystroke event
+     */
+    @Override
+    public void onKeypress(final TKeypressEvent keypress) {
+        if (keypress.equals(kbEnter)) {
+            dispatch();
+            return;
+        }
+
+        // Pass to parent for the things we don't care about.
+        super.onKeypress(keypress);
+    }
+
+    // ------------------------------------------------------------------------
+    // TWidget ----------------------------------------------------------------
+    // ------------------------------------------------------------------------
+
     /**
      * Draw a menu item with label.
      */
@@ -228,65 +221,119 @@ public class TMenuItem extends TWidget {
         }
 
         char cVSide = GraphicsChars.WINDOW_SIDE;
-        getScreen().vLineXY(0, 0, 1, cVSide, background);
-        getScreen().vLineXY(getWidth() - 1, 0, 1, cVSide, background);
+        vLineXY(0, 0, 1, cVSide, background);
+        vLineXY(getWidth() - 1, 0, 1, cVSide, background);
 
-        getScreen().hLineXY(1, 0, getWidth() - 2, ' ', menuColor);
-        getScreen().putStringXY(2, 0, mnemonic.getRawLabel(), menuColor);
+        hLineXY(1, 0, getWidth() - 2, ' ', menuColor);
+        putStringXY(2, 0, mnemonic.getRawLabel(), menuColor);
         if (key != null) {
             String keyLabel = key.toString();
-            getScreen().putStringXY((getWidth() - keyLabel.length() - 2), 0,
+            putStringXY((getWidth() - StringUtils.width(keyLabel) - 2), 0,
                 keyLabel, menuColor);
         }
-        if (mnemonic.getShortcutIdx() >= 0) {
-            getScreen().putCharXY(2 + mnemonic.getShortcutIdx(), 0,
+        if (mnemonic.getScreenShortcutIdx() >= 0) {
+            putCharXY(2 + mnemonic.getScreenShortcutIdx(), 0,
                 mnemonic.getShortcut(), menuMnemonicColor);
         }
         if (checked) {
             assert (checkable);
-            getScreen().putCharXY(1, 0, GraphicsChars.CHECK, menuColor);
+            putCharXY(1, 0, GraphicsChars.CHECK, menuColor);
         }
 
     }
 
+    // ------------------------------------------------------------------------
+    // TMenuItem --------------------------------------------------------------
+    // ------------------------------------------------------------------------
+
     /**
-     * Dispatch event(s) due to selection or click.
+     * Get the menu item ID.
+     *
+     * @return the id
      */
-    public void dispatch() {
-        assert (isEnabled());
+    public final int getId() {
+        return id;
+    }
 
-        getApplication().postMenuEvent(new TMenuEvent(id));
+    /**
+     * Set checkable flag.
+     *
+     * @param checkable if true, this menu item can be checked/unchecked
+     */
+    public final void setCheckable(final boolean checkable) {
+        this.checkable = checkable;
+    }
+
+    /**
+     * Get checkable flag.
+     *
+     * @return true if this menu item is both checkable and checked
+     */
+    public final boolean getChecked() {
+        return ((checkable == true) && (checked == true));
+    }
+
+    /**
+     * Set checked flag.  Note that setting checked on an item checkable will
+     * do nothing.
+     *
+     * @param checked if true, and if this menu item is checkable, then
+     * getChecked() will return true
+     */
+    public final void setChecked(final boolean checked) {
         if (checkable) {
-            checked = !checked;
+            this.checked = checked;
+        } else {
+            this.checked = false;
         }
     }
 
     /**
-     * Handle mouse button releases.
+     * Get the mnemonic string for this menu item.
      *
-     * @param mouse mouse button release event
+     * @return mnemonic string
      */
-    @Override
-    public void onMouseUp(final TMouseEvent mouse) {
-        if ((mouseOnMenuItem(mouse)) && (mouse.isMouse1())) {
-            dispatch();
-            return;
-        }
+    public final MnemonicString getMnemonic() {
+        return mnemonic;
     }
 
     /**
-     * Handle keystrokes.
+     * Get a global accelerator key for this menu item.
      *
-     * @param keypress keystroke event
+     * @return global keyboard accelerator, or null if no key is associated
+     * with this item
      */
-    @Override
-    public void onKeypress(final TKeypressEvent keypress) {
-        if (keypress.equals(kbEnter)) {
-            dispatch();
-            return;
+    public final TKeypress getKey() {
+        return key;
+    }
+
+    /**
+     * Set a global accelerator key for this menu item.
+     *
+     * @param key global keyboard accelerator
+     */
+    public final void setKey(final TKeypress key) {
+        this.key = key;
+
+        if (key != null) {
+            int newWidth = (StringUtils.width(label) + 4 +
+                StringUtils.width(key.toString()) + 2);
+            if (newWidth > getWidth()) {
+                setWidth(newWidth);
+            }
         }
+    }
 
-        // Pass to parent for the things we don't care about.
-        super.onKeypress(keypress);
+    /**
+     * Dispatch event(s) due to selection or click.
+     */
+    public void dispatch() {
+        assert (isEnabled());
+
+        getApplication().postMenuEvent(new TMenuEvent(id));
+        if (checkable) {
+            checked = !checked;
+        }
     }
+
 }