X-Git-Url: http://git.nikiroo.be/?p=fanfix.git;a=blobdiff_plain;f=src%2Fjexer%2FTLabel.java;h=cc341cfa862964ed9097c425ea4d10b55627ac0c;hp=d6b817a845b651e1fcccef01f5e863d0bb6b86eb;hb=HEAD;hpb=2ce6dab2bbd951e6d0f09f94759efda5ee4b65ac diff --git a/src/jexer/TLabel.java b/src/jexer/TLabel.java index d6b817a..cc341cf 100644 --- a/src/jexer/TLabel.java +++ b/src/jexer/TLabel.java @@ -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"), @@ -29,40 +29,43 @@ 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 final class TLabel extends TWidget { +public class TLabel extends TWidget { - /** - * Label text. - */ - private String label = ""; + // ------------------------------------------------------------------------ + // Variables -------------------------------------------------------------- + // ------------------------------------------------------------------------ /** - * Get label text. - * - * @return label text + * The shortcut and label. */ - public String getLabel() { - return label; - } + private MnemonicString mnemonic; /** - * Set label text. - * - * @param label new label text + * The action to perform when the mnemonic shortcut is pressed. */ - public void setLabel(final String label) { - this.label = label; - } + private TAction action; /** * Label color. */ private String colorKey; + /** + * If true, use the window's background color. + */ + private boolean useWindowBackground = true; + + // ------------------------------------------------------------------------ + // Constructors ----------------------------------------------------------- + // ------------------------------------------------------------------------ + /** * Public constructor, using the default "tlabel" for colorKey. * @@ -77,6 +80,21 @@ public final 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. * @@ -89,11 +107,88 @@ public final class TLabel extends TWidget { public TLabel(final TWidget parent, final String text, final int x, final int y, final String colorKey) { + 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. + * + * @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 + */ + 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 } /** @@ -103,11 +198,78 @@ public final class TLabel extends TWidget { public void draw() { // Setup my color CellAttributes color = new CellAttributes(); + CellAttributes mnemonicColor = new CellAttributes(); color.setTo(getTheme().getColor(colorKey)); - CellAttributes background = getWindow().getBackground(); - color.setBackColor(background.getBackColor()); + 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); + } + } - getScreen().putStringXY(0, 0, label, color); + // ------------------------------------------------------------------------ + // TLabel ----------------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * Get label raw text. + * + * @return label text + */ + public String getLabel() { + return mnemonic.getRawLabel(); + } + + /** + * Get the mnemonic string for this label. + * + * @return mnemonic string + */ + public MnemonicString getMnemonic() { + return mnemonic; + } + + /** + * Set label text. + * + * @param label new label text + */ + public void setLabel(final String 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); + } } }