2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2017 Kevin Lamonte
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
31 import jexer
.bits
.CellAttributes
;
34 * TLabel implements a simple label.
36 public class TLabel
extends TWidget
{
38 // ------------------------------------------------------------------------
39 // Variables --------------------------------------------------------------
40 // ------------------------------------------------------------------------
45 private String label
= "";
50 private String colorKey
;
53 * If true, use the window's background color.
55 private boolean useWindowBackground
= true;
57 // ------------------------------------------------------------------------
58 // Constructors -----------------------------------------------------------
59 // ------------------------------------------------------------------------
62 * Public constructor, using the default "tlabel" for colorKey.
64 * @param parent parent widget
65 * @param text label on the screen
66 * @param x column relative to parent
67 * @param y row relative to parent
69 public TLabel(final TWidget parent
, final String text
, final int x
,
72 this(parent
, text
, x
, y
, "tlabel");
78 * @param parent parent widget
79 * @param text label on the screen
80 * @param x column relative to parent
81 * @param y row relative to parent
82 * @param colorKey ColorTheme key color to use for foreground text
84 public TLabel(final TWidget parent
, final String text
, final int x
,
85 final int y
, final String colorKey
) {
87 this(parent
, text
, x
, y
, colorKey
, true);
93 * @param parent parent widget
94 * @param text label on the screen
95 * @param x column relative to parent
96 * @param y row relative to parent
97 * @param colorKey ColorTheme key color to use for foreground text
98 * @param useWindowBackground if true, use the window's background color
100 public TLabel(final TWidget parent
, final String text
, final int x
,
101 final int y
, final String colorKey
, final boolean useWindowBackground
) {
103 // Set parent and window
104 super(parent
, false, x
, y
, text
.length(), 1);
107 this.colorKey
= colorKey
;
108 this.useWindowBackground
= useWindowBackground
;
111 // ------------------------------------------------------------------------
112 // TWidget ----------------------------------------------------------------
113 // ------------------------------------------------------------------------
116 * Draw a static label.
121 CellAttributes color
= new CellAttributes();
122 color
.setTo(getTheme().getColor(colorKey
));
123 if (useWindowBackground
) {
124 CellAttributes background
= getWindow().getBackground();
125 color
.setBackColor(background
.getBackColor());
127 getScreen().putStringXY(0, 0, label
, color
);
130 // ------------------------------------------------------------------------
131 // TLabel -----------------------------------------------------------------
132 // ------------------------------------------------------------------------
139 public String
getLabel() {
146 * @param label new label text
148 public void setLabel(final String label
) {