Merge branch 'subtree'

[fanfix.git] / src / jexer / TLabel.java

diff --git a/src/jexer/TLabel.java b/src/jexer/TLabel.java
index 69e1efd22b01024e6ca3348c87f325197bd4b1a9..cc341cfa862964ed9097c425ea4d10b55627ac0c 100644 (file)
--- a/src/jexer/TLabel.java
+++ b/src/jexer/TLabel.java
@@ -29,9 +29,12 @@
 package jexer;
 
 import jexer.bits.CellAttributes;
+import jexer.bits.MnemonicString;
+import jexer.bits.StringUtils;
 
 /**
- * TLabel implements a simple label.
+ * TLabel implements a simple label, with an optional mnemonic hotkey action
+ * associated with it.
  */
 public class TLabel extends TWidget {
 
@@ -40,9 +43,14 @@ public class TLabel extends TWidget {
     // ------------------------------------------------------------------------
 
     /**
-     * Label text.
+     * The shortcut and label.
      */
-    private String label = "";
+    private MnemonicString mnemonic;
+
+    /**
+     * The action to perform when the mnemonic shortcut is pressed.
+     */
+    private TAction action;
 
     /**
      * Label color.
@@ -72,6 +80,21 @@ public class TLabel extends TWidget {
         this(parent, text, x, y, "tlabel");
     }
 
+    /**
+     * Public constructor, using the default "tlabel" for colorKey.
+     *
+     * @param parent parent widget
+     * @param text label on the screen
+     * @param x column relative to parent
+     * @param y row relative to parent
+     * @param action to call when shortcut is pressed
+     */
+    public TLabel(final TWidget parent, final String text, final int x,
+        final int y, final TAction action) {
+
+        this(parent, text, x, y, "tlabel", action);
+    }
+
     /**
      * Public constructor.
      *
@@ -87,6 +110,22 @@ public class TLabel extends TWidget {
         this(parent, text, x, y, colorKey, true);
     }
 
+    /**
+     * Public constructor.
+     *
+     * @param parent parent widget
+     * @param text label on the screen
+     * @param x column relative to parent
+     * @param y row relative to parent
+     * @param colorKey ColorTheme key color to use for foreground text
+     * @param action to call when shortcut is pressed
+     */
+    public TLabel(final TWidget parent, final String text, final int x,
+        final int y, final String colorKey, final TAction action) {
+
+        this(parent, text, x, y, colorKey, true, action);
+    }
+
     /**
      * Public constructor.
      *
@@ -100,18 +139,58 @@ public class TLabel extends TWidget {
     public TLabel(final TWidget parent, final String text, final int x,
         final int y, final String colorKey, final boolean useWindowBackground) {
 
+        this(parent, text, x, y, colorKey, useWindowBackground, null);
+    }
+
+    /**
+     * Public constructor.
+     *
+     * @param parent parent widget
+     * @param text label on the screen
+     * @param x column relative to parent
+     * @param y row relative to parent
+     * @param colorKey ColorTheme key color to use for foreground text
+     * @param useWindowBackground if true, use the window's background color
+     * @param action to call when shortcut is pressed
+     */
+    public TLabel(final TWidget parent, final String text, final int x,
+        final int y, final String colorKey, final boolean useWindowBackground,
+        final TAction action) {
+
         // Set parent and window
-        super(parent, false, x, y, text.length(), 1);
+        super(parent, false, x, y, 0, 1);
 
-        this.label = text;
+        setLabel(text);
         this.colorKey = colorKey;
         this.useWindowBackground = useWindowBackground;
+        this.action = action;
     }
 
     // ------------------------------------------------------------------------
     // TWidget ----------------------------------------------------------------
     // ------------------------------------------------------------------------
 
+    /**
+     * Override TWidget's width: we can only set width at construction time.
+     *
+     * @param width new widget width (ignored)
+     */
+    @Override
+    public void setWidth(final int width) {
+        // Do nothing
+    }
+
+    /**
+     * Override TWidget's height: we can only set height at construction
+     * time.
+     *
+     * @param height new widget height (ignored)
+     */
+    @Override
+    public void setHeight(final int height) {
+        // Do nothing
+    }
+
     /**
      * Draw a static label.
      */
@@ -119,12 +198,19 @@ public class TLabel extends TWidget {
     public void draw() {
         // Setup my color
         CellAttributes color = new CellAttributes();
+        CellAttributes mnemonicColor = new CellAttributes();
         color.setTo(getTheme().getColor(colorKey));
+        mnemonicColor.setTo(getTheme().getColor("tlabel.mnemonic"));
         if (useWindowBackground) {
             CellAttributes background = getWindow().getBackground();
             color.setBackColor(background.getBackColor());
+            mnemonicColor.setBackColor(background.getBackColor());
+        }
+        putStringXY(0, 0, mnemonic.getRawLabel(), color);
+        if (mnemonic.getScreenShortcutIdx() >= 0) {
+            putCharXY(mnemonic.getScreenShortcutIdx(), 0,
+                mnemonic.getShortcut(), mnemonicColor);
         }
-        putStringXY(0, 0, label, color);
     }
 
     // ------------------------------------------------------------------------
@@ -132,12 +218,21 @@ public class TLabel extends TWidget {
     // ------------------------------------------------------------------------
 
     /**
-     * Get label text.
+     * Get label raw text.
      *
      * @return label text
      */
     public String getLabel() {
-        return label;
+        return mnemonic.getRawLabel();
+    }
+
+    /**
+     * Get the mnemonic string for this label.
+     *
+     * @return mnemonic string
+     */
+    public MnemonicString getMnemonic() {
+        return mnemonic;
     }
 
     /**
@@ -146,7 +241,35 @@ public class TLabel extends TWidget {
      * @param label new label text
      */
     public void setLabel(final String label) {
-        this.label = label;
+        mnemonic = new MnemonicString(label);
+        super.setWidth(StringUtils.width(mnemonic.getRawLabel()));
+    }
+
+    /**
+     * Get the label color.
+     *
+     * @return the ColorTheme key color to use for foreground text
+     */
+    public String getColorKey() {
+        return colorKey;
+    }
+
+    /**
+     * Set the label color.
+     *
+     * @param colorKey ColorTheme key color to use for foreground text
+     */
+    public void setColorKey(final String colorKey) {
+        this.colorKey = colorKey;
+    }
+
+    /**
+     * Act as though the mnemonic shortcut was pressed.
+     */
+    public void dispatch() {
+        if (action != null) {
+            action.DO(this);
+        }
     }
 
 }