Package jexer

Class TStatusBar

java.lang.Object

jexer.TWidget

jexer.TStatusBar

All Implemented Interfaces:

java.lang.Comparable<TWidget>

public class TStatusBar
extends TWidget

TStatusBar implements a status line with clickable buttons.

Constructor Summary

Constructors

Constructor	Description
TStatusBar(TWindow window)	Public constructor.
TStatusBar(TWindow window, java.lang.String text)	Public constructor.

Method Summary

Modifier and Type	Method	Description
void	addShortcutKeypress(TKeypress key, TCommand cmd, java.lang.String label)	Add a key to this status bar.
void	draw()	Draw the bar.
void	setText(java.lang.String text)	Set the text to display on the right side of the shortcut keys.
boolean	statusBarKeypress(TKeypressEvent keypress)	Handle keypresses.
boolean	statusBarMouseDown(TMouseEvent mouse)	Handle mouse button presses.
void	statusBarMouseMotion(TMouseEvent mouse)	Handle mouse movements.
boolean	statusBarMouseUp(TMouseEvent mouse)	Handle mouse button releases.

Methods inherited from class jexer.TWidget

activate, activate, activate, activateAll, addButton, addCalendar, addCheckBox, addCheckBox, addComboBox, addDirectoryList, addDirectoryList, addDirectoryList, addDirectoryList, addEditor, addField, addField, addField, addField, addImage, addImage, addImage, addImage, addLabel, addLabel, addLabel, addLabel, addLabel, addLabel, addList, addList, addList, addList, addPanel, addPasswordField, addPasswordField, addPasswordField, addProgressBar, addRadioGroup, addRadioGroup, addSpinner, addSplitPane, addTable, addTable, addText, addText, addTreeViewWidget, addTreeViewWidget, close, compareTo, doRepaint, drawBox, drawBox, drawBoxShadow, drawChildren, fileOpenBox, fileOpenBox, fileOpenBox, fileOpenBox, fileSaveBox, getAbsoluteX, getAbsoluteY, getActiveChild, getApplication, getAttrXY, getChildren, getClipboard, getCursorAbsoluteX, getCursorAbsoluteY, getCursorX, getCursorY, getCustomMousePointer, getHeight, getLayoutManager, getLocale, getMouseStyle, getParent, getScreen, getTheme, getWidgetUnderMouse, getWidth, getWindow, getX, getY, handleEvent, hasChild, hLineXY, hLineXY, inputBox, inputBox, inputBox, isAbsoluteActive, isActive, isCursorVisible, isDrawable, isEchoKeystrokes, isEnabled, isPixelMouse, 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, setCustomMousePointer, setDimensions, setEchoKeystrokes, setEchoKeystrokes, setEnabled, setHeight, setLayoutManager, setLocale, setMouseStyle, setParent, setupForTWindow, setVisible, setWidth, setWindow, setX, setY, splitHorizontal, splitVertical, switchWidget, toPrettyString, toPrettyString, toString, vLineXY, vLineXY

Methods inherited from class java.lang.Object

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

Constructor Detail

TStatusBar

public TStatusBar(TWindow window,
                  java.lang.String text)

Public constructor.

Parameters:

window - the window associated with this status bar

text - text for the bar on the bottom row

TStatusBar

public TStatusBar(TWindow window)

Public constructor.

Parameters:

window - the window associated with this status bar

Method Detail

statusBarKeypress

public boolean statusBarKeypress(TKeypressEvent keypress)

Handle keypresses.

Parameters:

keypress - keystroke event

Returns:

true if this keypress was consumed

statusBarMouseDown

public boolean statusBarMouseDown(TMouseEvent mouse)

Handle mouse button presses.

Parameters:

mouse - mouse button event

Returns:

true if this mouse event was consumed

statusBarMouseUp

public boolean statusBarMouseUp(TMouseEvent mouse)

Handle mouse button releases.

Parameters:

mouse - mouse button release event

Returns:

true if this mouse event was consumed

statusBarMouseMotion

public void statusBarMouseMotion(TMouseEvent mouse)

Handle mouse movements.

Parameters:

mouse - mouse motion event

draw

public void draw()

Draw the bar.

Overrides:

draw in class TWidget

addShortcutKeypress

public void addShortcutKeypress(TKeypress key,
                                TCommand cmd,
                                java.lang.String label)

Add a key to this status bar.

Parameters:

key - the key to trigger on

cmd - the command event to issue when key is pressed or this item is clicked

label - the label for this action

setText

public void setText(java.lang.String text)

Set the text to display on the right side of the shortcut keys.

Parameters:

text - the new text