Package jexer.help

Class THelpText

java.lang.Object

jexer.TWidget

jexer.TScrollableWidget

jexer.help.THelpText

All Implemented Interfaces:

java.lang.Comparable<TWidget>, Scrollable

public class THelpText
extends TScrollableWidget

THelpText displays help text with clickable links in a scrollable text area. It reflows automatically on resize.

Field Summary

Fields inherited from class jexer.TScrollableWidget

hScroller, vScroller

Constructor Summary

Constructors

Constructor	Description
THelpText(THelpWindow parent, Topic topic, int x, int y, int width, int height)	Public constructor.

Method Summary

Modifier and Type	Method	Description
void	draw()	Draw the text box.
void	onKeypress(TKeypressEvent keypress)	Handle keystrokes.
void	onMouseDown(TMouseEvent mouse)	Handle mouse press events.
protected void	placeScrollbars()	Place the scrollbars on the edge of this widget, and adjust bigChange to match the new size.
void	reflowData()	Resize text and scrollbars for a new width/height.
void	setHeight(int height)	Override TWidget's height: we need to set child widget heights.
void	setTopic(Topic topic)	Set the topic.
void	setTopic(Topic topic, boolean separator)	Set the topic.
void	setWidth(int width)	Override TWidget's width: we need to set child widget widths.

Methods inherited from class jexer.TScrollableWidget

bigHorizontalDecrement, bigHorizontalIncrement, bigVerticalDecrement, bigVerticalIncrement, getBottomValue, getHorizontalBigChange, getHorizontalScroller, getHorizontalSmallChange, getHorizontalValue, getLeftValue, getRightValue, getTopValue, getVerticalBigChange, getVerticalScroller, getVerticalSmallChange, getVerticalValue, horizontalDecrement, horizontalIncrement, onResize, setBottomValue, setHorizontalBigChange, setHorizontalSmallChange, setHorizontalValue, setLeftValue, setRightValue, setTopValue, setVerticalBigChange, setVerticalSmallChange, setVerticalValue, toBottom, toEnd, toHome, toLeft, toRight, toTop, verticalDecrement, verticalIncrement

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, 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, getMouseStyle, getParent, getScreen, getTheme, getWidgetUnderMouse, getWidth, getWindow, getX, getY, handleEvent, hasChild, hLineXY, inputBox, inputBox, inputBox, isAbsoluteActive, isActive, isCursorVisible, isDrawable, isEchoKeystrokes, isEnabled, isPixelMouse, isVisible, messageBox, messageBox, mouseWouldHit, onCommand, onIdle, onMenu, onMouseDoubleClick, onMouseMotion, onMouseUp, putAll, putAttrXY, putAttrXY, putCharXY, putCharXY, putCharXY, putStringXY, putStringXY, remove, remove, remove, remove, removeAll, resetTabOrder, setActive, setCursorVisible, setCursorX, setCursorY, setCustomMousePointer, setDimensions, setEchoKeystrokes, setEchoKeystrokes, setEnabled, setLayoutManager, setMouseStyle, 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

THelpText

public THelpText(THelpWindow parent,
                 Topic topic,
                 int x,
                 int y,
                 int width,
                 int height)

Public constructor.

Parameters:

parent - parent widget

topic - the topic to display

x - column relative to parent

y - row relative to parent

width - width of text area

height - height of text area

Method Detail

setWidth

public void setWidth(int width)

Override TWidget's width: we need to set child widget widths.

Overrides:

setWidth in class TWidget

Parameters:

width - new widget width

setHeight

public void setHeight(int height)

Override TWidget's height: we need to set child widget heights. time.

Overrides:

setHeight in class TWidget

Parameters:

height - new widget height

onMouseDown

public void onMouseDown(TMouseEvent mouse)

Handle mouse press events.

Overrides:

onMouseDown in class TWidget

Parameters:

mouse - mouse button press event

onKeypress

public void onKeypress(TKeypressEvent keypress)

Handle keystrokes.

Overrides:

onKeypress in class TWidget

Parameters:

keypress - keystroke event

placeScrollbars

protected void placeScrollbars()

Place the scrollbars on the edge of this widget, and adjust bigChange to match the new size. This is called by onResize().

Overrides:

placeScrollbars in class TScrollableWidget

reflowData

public void reflowData()

Resize text and scrollbars for a new width/height.

Overrides:

reflowData in class TScrollableWidget

draw

public void draw()

Draw the text box.

Overrides:

draw in class TWidget

setTopic

public void setTopic(Topic topic)

Set the topic.

Parameters:

topic - new topic to display

setTopic

public void setTopic(Topic topic,
                     boolean separator)

Set the topic.

Parameters:

topic - new topic to display

separator - if true, separate paragraphs