jexer

Class TLabel

java.lang.Object

jexer.TWidget

jexer.TLabel

All Implemented Interfaces:

java.lang.Comparable<TWidget>

public class TLabel
extends TWidget

TLabel implements a simple label, with an optional mnemonic hotkey action associated with it.

Constructor Summary

Constructors

Constructor and Description
TLabel(TWidget parent, java.lang.String text, int x, int y) Public constructor, using the default "tlabel" for colorKey.
TLabel(TWidget parent, java.lang.String text, int x, int y, java.lang.String colorKey) Public constructor.
TLabel(TWidget parent, java.lang.String text, int x, int y, java.lang.String colorKey, boolean useWindowBackground) Public constructor.
TLabel(TWidget parent, java.lang.String text, int x, int y, java.lang.String colorKey, boolean useWindowBackground, TAction action) Public constructor.
TLabel(TWidget parent, java.lang.String text, int x, int y, java.lang.String colorKey, TAction action) Public constructor.
TLabel(TWidget parent, java.lang.String text, int x, int y, TAction action) Public constructor, using the default "tlabel" for colorKey.

Method Summary

Modifier and Type	Method and Description
void	dispatch() Act as though the mnemonic shortcut was pressed.
void	draw() Draw a static label.
java.lang.String	getColorKey() Get the label color.
java.lang.String	getLabel() Get label raw text.
MnemonicString	getMnemonic() Get the mnemonic string for this label.
void	setColorKey(java.lang.String colorKey) Set the label color.
void	setHeight(int height) Override TWidget's height: we can only set height at construction time.
void	setLabel(java.lang.String label) Set label text.
void	setWidth(int width) Override TWidget's width: we can only set width at construction time.

Methods inherited from class jexer.TWidget

activate, activate, activate, activateAll, addButton, addCalendar, addCheckBox, addComboBox, addDirectoryList, addDirectoryList, addDirectoryList, addDirectoryList, addEditor, addField, addField, addField, addImage, addImage, addLabel, addLabel, addLabel, addLabel, addLabel, addLabel, addList, addList, addList, addList, addPanel, addPasswordField, addPasswordField, addPasswordField, addProgressBar, addRadioGroup, addSpinner, addSplitPane, addTable, addTable, addText, addText, addTreeViewWidget, addTreeViewWidget, close, compareTo, doRepaint, drawBox, drawBox, drawBoxShadow, fileOpenBox, fileOpenBox, fileOpenBox, fileOpenBox, fileSaveBox, getAbsoluteX, getAbsoluteY, getActiveChild, getApplication, getAttrXY, getChildren, getCursorAbsoluteX, getCursorAbsoluteY, getCursorX, getCursorY, getHeight, getLayoutManager, getParent, getScreen, getTheme, getWidth, getWindow, getX, getY, handleEvent, hLineXY, inputBox, inputBox, inputBox, isAbsoluteActive, isActive, isCursorVisible, isDrawable, isEnabled, isVisible, messageBox, messageBox, mouseWouldHit, onCommand, onIdle, onKeypress, onMenu, onMouseDoubleClick, onMouseDown, onMouseMotion, onMouseUp, onResize, putAll, putAttrXY, putAttrXY, putCharXY, putCharXY, putCharXY, putStringXY, putStringXY, remove, remove, remove, remove, removeAll, resetTabOrder, setActive, setCursorVisible, setCursorX, setCursorY, setDimensions, setEnabled, setLayoutManager, setParent, setupForTWindow, setVisible, setWindow, setX, setY, splitHorizontal, splitVertical, switchWidget, toPrettyString, toPrettyString, toString, vLineXY

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TLabel

public TLabel(TWidget parent,
              java.lang.String text,
              int x,
              int y)

Public constructor, using the default "tlabel" for colorKey.

Parameters:

parent - parent widget

text - label on the screen

x - column relative to parent

y - row relative to parent

TLabel

public TLabel(TWidget parent,
              java.lang.String text,
              int x,
              int y,
              TAction action)

Public constructor, using the default "tlabel" for colorKey.

Parameters:

parent - parent widget

text - label on the screen

x - column relative to parent

y - row relative to parent

action - to call when shortcut is pressed

TLabel

public TLabel(TWidget parent,
              java.lang.String text,
              int x,
              int y,
              java.lang.String colorKey)

Public constructor.

Parameters:

parent - parent widget

text - label on the screen

x - column relative to parent

y - row relative to parent

colorKey - ColorTheme key color to use for foreground text

TLabel

public TLabel(TWidget parent,
              java.lang.String text,
              int x,
              int y,
              java.lang.String colorKey,
              TAction action)

Public constructor.

Parameters:

parent - parent widget

text - label on the screen

x - column relative to parent

y - row relative to parent

colorKey - ColorTheme key color to use for foreground text

action - to call when shortcut is pressed

TLabel

public TLabel(TWidget parent,
              java.lang.String text,
              int x,
              int y,
              java.lang.String colorKey,
              boolean useWindowBackground)

Public constructor.

Parameters:

parent - parent widget

text - label on the screen

x - column relative to parent

y - row relative to parent

colorKey - ColorTheme key color to use for foreground text

useWindowBackground - if true, use the window's background color

TLabel

public TLabel(TWidget parent,
              java.lang.String text,
              int x,
              int y,
              java.lang.String colorKey,
              boolean useWindowBackground,
              TAction action)

Public constructor.

Parameters:

parent - parent widget

text - label on the screen

x - column relative to parent

y - row relative to parent

colorKey - ColorTheme key color to use for foreground text

useWindowBackground - if true, use the window's background color

action - to call when shortcut is pressed

Method Detail

setWidth

public void setWidth(int width)

Override TWidget's width: we can only set width at construction time.

Overrides:

setWidth in class TWidget

Parameters:

width - new widget width (ignored)

setHeight

public void setHeight(int height)

Override TWidget's height: we can only set height at construction time.

Overrides:

setHeight in class TWidget

Parameters:

height - new widget height (ignored)

draw

public void draw()

Draw a static label.

Overrides:

draw in class TWidget

getLabel

public java.lang.String getLabel()

Get label raw text.

Returns:

label text

getMnemonic

public MnemonicString getMnemonic()

Get the mnemonic string for this label.

Returns:

mnemonic string

setLabel

public void setLabel(java.lang.String label)

Set label text.

Parameters:

label - new label text

getColorKey

public java.lang.String getColorKey()

Get the label color.

Returns:

the ColorTheme key color to use for foreground text

setColorKey

public void setColorKey(java.lang.String colorKey)

Set the label color.

Parameters:

colorKey - ColorTheme key color to use for foreground text

dispatch

public void dispatch()

Act as though the mnemonic shortcut was pressed.