X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2FTLabel.java;h=f33a8d75f51ac7f6045f3dbc6b8d97934157af2d;hb=00691e80f2f135f92be739e2b7e86775a2357276;hp=f5e966581a6dbffb6026fe088c3d1a6246491e21;hpb=e16dda65585466c8987bd1efd718431450a96605;p=nikiroo-utils.git diff --git a/src/jexer/TLabel.java b/src/jexer/TLabel.java index f5e9665..f33a8d7 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,42 @@ package jexer; import jexer.bits.CellAttributes; +import jexer.bits.MnemonicString; /** - * 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 +79,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,24 +106,129 @@ 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); - this.label = text; + mnemonic = new MnemonicString(text); this.colorKey = colorKey; + this.useWindowBackground = useWindowBackground; + this.action = action; } + // ------------------------------------------------------------------------ + // TWidget ---------------------------------------------------------------- + // ------------------------------------------------------------------------ + /** * Draw a static label. */ - @Override public void draw() { + @Override + 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.getShortcutIdx() >= 0) { + putCharXY(mnemonic.getShortcutIdx(), 0, + mnemonic.getShortcut(), mnemonicColor); + } + } + + // ------------------------------------------------------------------------ + // TLabel ----------------------------------------------------------------- + // ------------------------------------------------------------------------ - getScreen().putStringXY(0, 0, label, color); + /** + * 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); + } + + /** + * Act as though the mnemonic shortcut was pressed. + */ + public void dispatch() { + if (action != null) { + action.DO(); + } } }