Package jexer

Class TButton

java.lang.Object

jexer.TWidget

jexer.TButton

All Implemented Interfaces:

java.lang.Comparable<TWidget>

public class TButton
extends TWidget

TButton implements a simple button. To make the button do something, pass a TAction class to its constructor.

See Also:

TAction.DO()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TButton.Style	Available styles of the button.

Constructor Summary

Constructors

Constructor	Description
TButton(TWidget parent, java.lang.String text, int x, int y, TAction action)	Public constructor.

Method Summary

Modifier and Type	Method	Description
void	dispatch()	Act as though the button was pressed.
void	draw()	Draw a button with a shadow.
MnemonicString	getMnemonic()	Get the mnemonic string for this button.
void	onKeypress(TKeypressEvent keypress)	Handle keystrokes.
void	onMouseDown(TMouseEvent mouse)	Handle mouse button presses.
void	onMouseMotion(TMouseEvent mouse)	Handle mouse movements.
void	onMouseUp(TMouseEvent mouse)	Handle mouse button releases.
void	setEnabled(boolean enabled)	Override TWidget.setActive() so that the button ends are redrawn.
void	setHeight(int height)	Override TWidget's height: we can only set height at construction time.
void	setShadowColor(CellAttributes color)	Set the background color used for the button "shadow".
void	setStyle(java.lang.String buttonStyle)	Set the button style.
void	setStyle(TButton.Style style)	Set the button style.
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, 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, onMenu, onMouseDoubleClick, onResize, putAll, putAttrXY, putAttrXY, putCharXY, putCharXY, putCharXY, putStringXY, putStringXY, remove, remove, remove, remove, removeAll, resetTabOrder, setActive, setCursorVisible, setCursorX, setCursorY, setCustomMousePointer, setDimensions, setEchoKeystrokes, setEchoKeystrokes, setLayoutManager, setLocale, setMouseStyle, setParent, setupForTWindow, setVisible, 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

TButton

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

Public constructor.

Parameters:

parent - parent widget

text - label on the button

x - column relative to parent

y - row relative to parent

action - to call when button is pressed

Method Detail

onMouseDown

public void onMouseDown(TMouseEvent mouse)

Handle mouse button presses.

Overrides:

onMouseDown in class TWidget

Parameters:

mouse - mouse button event

onMouseUp

public void onMouseUp(TMouseEvent mouse)

Handle mouse button releases.

Overrides:

onMouseUp in class TWidget

Parameters:

mouse - mouse button release event

onMouseMotion

public void onMouseMotion(TMouseEvent mouse)

Handle mouse movements.

Overrides:

onMouseMotion in class TWidget

Parameters:

mouse - mouse motion event

onKeypress

public void onKeypress(TKeypressEvent keypress)

Handle keystrokes.

Overrides:

onKeypress in class TWidget

Parameters:

keypress - keystroke event

setEnabled

public void setEnabled(boolean enabled)

Override TWidget.setActive() so that the button ends are redrawn.

Overrides:

setEnabled in class TWidget

Parameters:

enabled - if true, this widget can be tabbed to or receive events

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 button with a shadow.

Overrides:

draw in class TWidget

getMnemonic

public MnemonicString getMnemonic()

Get the mnemonic string for this button.

Returns:

mnemonic string

dispatch

public void dispatch()

Act as though the button was pressed. This is useful for other UI elements to get the same action as if the user clicked the button.

setShadowColor

public void setShadowColor(CellAttributes color)

Set the background color used for the button "shadow". If null, no shadow will be drawn.

Parameters:

color - the new background color, or null for no shadow

setStyle

public void setStyle(TButton.Style style)

Set the button style.

Parameters:

style - SQUARE, ROUND, etc.

setStyle

public void setStyle(java.lang.String buttonStyle)

Set the button style.

Parameters:

buttonStyle - the button style string, one of: "square", "round", "diamond", "leftArrow", or "rightArrow"; or null to use the value from jexer.TButton.style.