Package jexer

Class THelpWindow

java.lang.Object

jexer.TWidget

jexer.TWindow

jexer.THelpWindow

All Implemented Interfaces:

java.lang.Comparable<TWidget>

public class THelpWindow
extends TWindow

THelpWindow

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	HELP_HELP	"Help On Help".

Fields inherited from class jexer.TWindow

ABSOLUTEXY, borderStyleActive, borderStyleActiveModal, borderStyleInactive, borderStyleMoving, CENTERED, helpTopic, HIDEONCLOSE, inKeyboardResize, inWindowMove, inWindowResize, MODAL, mouse, NOCLOSEBOX, NOZOOMBOX, overlay, OVERRIDEMENU, RESIZABLE, statusBar, underlay

Constructor Summary

Constructors

Constructor	Description
THelpWindow(TApplication application)	Public constructor.
THelpWindow(TApplication application, java.lang.String topic)	Public constructor.
THelpWindow(TApplication application, Topic topic)	Public constructor.

Method Summary

Modifier and Type	Method	Description
CellAttributes	getBackground()	Retrieve the background color.
CellAttributes	getBorder()	Retrieve the border color.
CellAttributes	getBorderControls()	Retrieve the color used by the window movement/sizing controls.
void	onResize(TResizeEvent event)	Handle window/screen resize events.
void	setHelpTopic(java.lang.String topic)	Set the topic to display.

Methods inherited from class jexer.TWindow

activate, addOverlay, addShortcutKeypress, addUnderlay, center, clearShortcutKeypresses, close, disableCloseEffect, disableOpenEffect, draw, ensureOnScreen, getAlpha, getApplication, getBorderStyle, getBorderStyleForeground, getBorderStyleInactive, getBorderStyleModal, getBorderStyleMoving, getHelpTopic, getMaximumWindowHeight, getMaximumWindowWidth, getMinimumWindowHeight, getMinimumWindowWidth, getMouseStyle, getScreen, getStatusBar, getTitle, getWindowTheme, getZ, hasCloseBox, hasHiddenMouse, hasOverriddenMenu, hasZoomBox, hide, inMovements, isHidden, isModal, isResizable, isShortcutKeypress, isShown, maximize, mouseOnClose, mouseOnMaximize, mouseOnResize, newStatusBar, onClose, onCommand, onFocus, onHide, onKeypress, onMenu, onMouseDown, onMouseMotion, onMouseUp, onPostDraw, onPreClose, onShow, onUnfocus, removeShortcutKeypress, restore, setAlpha, setBorderStyleForeground, setBorderStyleInactive, setBorderStyleModal, setBorderStyleMoving, setCloseBox, setHiddenMouse, setMaximumWindowHeight, setMaximumWindowWidth, setMinimumWindowHeight, setMinimumWindowWidth, setResizable, setTackboardsDirty, setTitle, setWindowTheme, setZ, setZoomBox, show, stopMovements, toString

Methods inherited from class jexer.TWidget

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, compareTo, doRepaint, drawBox, drawBox, drawBoxShadow, drawChildren, fileOpenBox, fileOpenBox, fileOpenBox, fileOpenBox, fileSaveBox, getAbsoluteX, getAbsoluteY, getActiveChild, getAttrXY, getChildren, getClipboard, getCursorAbsoluteX, getCursorAbsoluteY, getCursorX, getCursorY, getCustomMousePointer, getHeight, getLayoutManager, getLocale, getParent, getTheme, getWidgetUnderMouse, getWidth, getWindow, getX, getY, handleEvent, hasChild, hLineXY, hLineXY, inputBox, inputBox, inputBox, isAbsoluteActive, isActive, isCursorVisible, isDrawable, isEchoKeystrokes, isEnabled, isPixelMouse, isVisible, messageBox, messageBox, mouseWouldHit, onIdle, onMouseDoubleClick, 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, vLineXY, vLineXY

Methods inherited from class java.lang.Object

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

Field Detail

HELP_HELP

public static java.lang.String HELP_HELP

"Help On Help".

Constructor Detail

THelpWindow

public THelpWindow(TApplication application,
                   java.lang.String topic)

Public constructor.

Parameters:

application - TApplication that manages this window

topic - the topic to start on

THelpWindow

public THelpWindow(TApplication application,
                   Topic topic)

Public constructor.

Parameters:

application - TApplication that manages this window

topic - the topic to start on

THelpWindow

public THelpWindow(TApplication application)

Public constructor.

Parameters:

application - TApplication that manages this window

Method Detail

onResize

public void onResize(TResizeEvent event)

Handle window/screen resize events.

Overrides:

onResize in class TWindow

Parameters:

event - resize event

getBackground

public final CellAttributes getBackground()

Retrieve the background color.

Overrides:

getBackground in class TWindow

Returns:

the background color

getBorder

public CellAttributes getBorder()

Retrieve the border color.

Overrides:

getBorder in class TWindow

Returns:

the border color

getBorderControls

public CellAttributes getBorderControls()

Retrieve the color used by the window movement/sizing controls.

Overrides:

getBorderControls in class TWindow

Returns:

the color used by the zoom box, resize bar, and close box

setHelpTopic

public void setHelpTopic(java.lang.String topic)

Set the topic to display.

Parameters:

topic - the topic to display