Package jexer

Class TScrollableWindow

java.lang.Object

jexer.TWidget

jexer.TWindow

jexer.TScrollableWindow

All Implemented Interfaces:

java.lang.Comparable<TWidget>, Scrollable

Direct Known Subclasses:

TEditorWindow, TImageWindow, TTableWindow, TTerminalWindow, TTextPictureWindow, TTreeViewWindow

public class TScrollableWindow
extends TWindow
implements Scrollable

TScrollableWindow is a convenience superclass for windows that have scrollbars.

Field Summary

Fields

Modifier and Type	Field	Description
protected THScroller	hScroller	The horizontal scrollbar.
protected TVScroller	vScroller	The vertical scrollbar.

Fields inherited from class jexer.TWindow

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

Constructor Summary

Constructors

Constructor	Description
TScrollableWindow(TApplication application, java.lang.String title, int width, int height)	Public constructor.
TScrollableWindow(TApplication application, java.lang.String title, int width, int height, int flags)	Public constructor.
TScrollableWindow(TApplication application, java.lang.String title, int x, int y, int width, int height)	Public constructor.
TScrollableWindow(TApplication application, java.lang.String title, int x, int y, int width, int height, int flags)	Public constructor.

Method Summary

Modifier and Type	Method	Description
void	bigHorizontalDecrement()	Perform a big step change left.
void	bigHorizontalIncrement()	Perform a big step change right.
void	bigVerticalDecrement()	Perform a big step change up.
void	bigVerticalIncrement()	Perform a big step change down.
int	getBottomValue()	Get the value that corresponds to being on the bottom edge of the vertical scroll bar.
int	getHorizontalBigChange()	Get the increment for clicking in the bar between the box and an arrow on the horizontal scrollbar.
THScroller	getHorizontalScroller()	Get the horizontal scrollbar, or null if this Viewport does not support horizontal scrolling.
int	getHorizontalSmallChange()	Get the increment for clicking on an arrow on the horizontal scrollbar.
int	getHorizontalValue()	Get current value of the horizontal scroll.
int	getLeftValue()	Get the value that corresponds to being on the left edge of the horizontal scroll bar.
int	getRightValue()	Get the value that corresponds to being on the right edge of the horizontal scroll bar.
int	getTopValue()	Get the value that corresponds to being on the top edge of the vertical scroll bar.
int	getVerticalBigChange()	Get the increment for clicking in the bar between the box and an arrow on the vertical scrollbar.
TVScroller	getVerticalScroller()	Get the vertical scrollbar, or null if this Viewport does not support vertical scrolling.
int	getVerticalSmallChange()	Get the increment for clicking on an arrow on the vertical scrollbar.
int	getVerticalValue()	Get current value of the vertical scroll.
void	horizontalDecrement()	Perform a small step change left.
void	horizontalIncrement()	Perform a small step change right.
void	maximize()	Maximize window.
protected boolean	mouseOnHorizontalScroller(TMouseEvent mouse)	Check if a mouse press/release/motion event coordinate is over the horizontal scrollbar.
protected boolean	mouseOnVerticalScroller(TMouseEvent mouse)	Check if a mouse press/release/motion event coordinate is over the vertical scrollbar.
void	onResize(TResizeEvent event)	Handle window/screen resize events.
protected void	placeScrollbars()	Place the scrollbars on the edge of this widget, and adjust bigChange to match the new size.
void	reflowData()	Recompute whatever data is displayed by this widget.
void	restore()	Restore (unmaximize) window.
void	setBottomValue(int bottomValue)	Set the value that corresponds to being on the bottom edge of the vertical scroll bar.
void	setHorizontalBigChange(int bigChange)	Set the increment for clicking in the bar between the box and an arrow on the horizontal scrollbar.
void	setHorizontalSmallChange(int smallChange)	Set the increment for clicking on an arrow on the horizontal scrollbar.
void	setHorizontalValue(int value)	Set current value of the horizontal scroll.
void	setLeftValue(int leftValue)	Set the value that corresponds to being on the left edge of the horizontal scroll bar.
void	setRightValue(int rightValue)	Set the value that corresponds to being on the right edge of the horizontal scroll bar.
void	setTopValue(int topValue)	Set the value that corresponds to being on the top edge of the vertical scroll bar.
void	setVerticalBigChange(int bigChange)	Set the increment for clicking in the bar between the box and an arrow on the vertical scrollbar.
void	setVerticalSmallChange(int smallChange)	Set the increment for clicking on an arrow on the vertical scrollbar.
void	setVerticalValue(int value)	Set current value of the vertical scroll.
void	toBottom()	Go to the bottom edge of the vertical scroller.
void	toEnd()	Go to the bottom-right edge of the horizontal and vertical scrollers.
void	toHome()	Go to the top-left edge of the horizontal and vertical scrollers.
void	toLeft()	Go to the left edge of the horizontal scroller.
void	toRight()	Go to the right edge of the horizontal scroller.
void	toTop()	Go to the top edge of the vertical scroller.
void	verticalDecrement()	Perform a small step change up.
void	verticalIncrement()	Perform a small step change down.

Methods inherited from class jexer.TWindow

activate, addOverlay, addShortcutKeypress, addUnderlay, center, clearShortcutKeypresses, close, draw, ensureOnScreen, getApplication, getBackground, getBorder, getBorderControls, getHelpTopic, getMaximumWindowHeight, getMaximumWindowWidth, getMinimumWindowHeight, getMinimumWindowWidth, getScreen, getStatusBar, getTitle, getZ, hasCloseBox, hasHiddenMouse, hasOverriddenMenu, hasZoomBox, hide, inMovements, isHidden, isModal, isResizable, isShortcutKeypress, isShown, mouseOnClose, mouseOnMaximize, mouseOnResize, newStatusBar, onClose, onCommand, onFocus, onHide, onKeypress, onMenu, onMouseDown, onMouseMotion, onMouseUp, onPreClose, onShow, onUnfocus, removeShortcutKeypress, setCloseBox, setHiddenMouse, setMaximumWindowHeight, setMaximumWindowWidth, setMinimumWindowHeight, setMinimumWindowWidth, setResizable, setTackboardsDirty, setTitle, 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, 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, getMouseStyle, getParent, getTheme, getWidgetUnderMouse, getWidth, getWindow, getX, getY, handleEvent, hasChild, 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, setMouseStyle, setParent, setupForTWindow, setVisible, setWidth, setWindow, setX, setY, splitHorizontal, splitVertical, switchWidget, toPrettyString, toPrettyString, vLineXY

Methods inherited from class java.lang.Object

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

Field Detail

hScroller

protected THScroller hScroller

The horizontal scrollbar.

vScroller

protected TVScroller vScroller

The vertical scrollbar.

Constructor Detail

TScrollableWindow

public TScrollableWindow(TApplication application,
                         java.lang.String title,
                         int width,
                         int height)

Public constructor. Window will be located at (0, 0).

Parameters:

application - TApplication that manages this window

title - window title, will be centered along the top border

width - width of window

height - height of window

TScrollableWindow

public TScrollableWindow(TApplication application,
                         java.lang.String title,
                         int width,
                         int height,
                         int flags)

Public constructor. Window will be located at (0, 0).

Parameters:

application - TApplication that manages this window

title - window title, will be centered along the top border

width - width of window

height - height of window

flags - bitmask of RESIZABLE, CENTERED, or MODAL

TScrollableWindow

public TScrollableWindow(TApplication application,
                         java.lang.String title,
                         int x,
                         int y,
                         int width,
                         int height)

Public constructor.

Parameters:

application - TApplication that manages this window

title - window title, will be centered along the top border

x - column relative to parent

y - row relative to parent

width - width of window

height - height of window

TScrollableWindow

public TScrollableWindow(TApplication application,
                         java.lang.String title,
                         int x,
                         int y,
                         int width,
                         int height,
                         int flags)

Public constructor.

Parameters:

application - TApplication that manages this window

title - window title, will be centered along the top border

x - column relative to parent

y - row relative to parent

width - width of window

height - height of window

flags - mask of RESIZABLE, CENTERED, or MODAL

Method Detail

onResize

public void onResize(TResizeEvent event)

Handle window/screen resize events.

Overrides:

onResize in class TWindow

Parameters:

event - resize event

maximize

public void maximize()

Maximize window.

Overrides:

maximize in class TWindow

restore

public void restore()

Restore (unmaximize) window.

Overrides:

restore in class TWindow

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().

reflowData

public void reflowData()

Recompute whatever data is displayed by this widget.

getHorizontalScroller

public THScroller getHorizontalScroller()

Get the horizontal scrollbar, or null if this Viewport does not support horizontal scrolling.

Specified by:

getHorizontalScroller in interface Scrollable

Returns:

the horizontal scrollbar

getVerticalScroller

public TVScroller getVerticalScroller()

Get the vertical scrollbar, or null if this Viewport does not support vertical scrolling.

Specified by:

getVerticalScroller in interface Scrollable

Returns:

the vertical scrollbar

getTopValue

public int getTopValue()

Get the value that corresponds to being on the top edge of the vertical scroll bar.

Specified by:

getTopValue in interface Scrollable

Returns:

the scroll value

setTopValue

public void setTopValue(int topValue)

Set the value that corresponds to being on the top edge of the vertical scroll bar.

Specified by:

setTopValue in interface Scrollable

Parameters:

topValue - the new scroll value

getBottomValue

public int getBottomValue()

Get the value that corresponds to being on the bottom edge of the vertical scroll bar.

Specified by:

getBottomValue in interface Scrollable

Returns:

the scroll value

setBottomValue

public void setBottomValue(int bottomValue)

Set the value that corresponds to being on the bottom edge of the vertical scroll bar.

Specified by:

setBottomValue in interface Scrollable

Parameters:

bottomValue - the new scroll value

getVerticalValue

public int getVerticalValue()

Get current value of the vertical scroll.

Specified by:

getVerticalValue in interface Scrollable

Returns:

the scroll value

setVerticalValue

public void setVerticalValue(int value)

Set current value of the vertical scroll.

Specified by:

setVerticalValue in interface Scrollable

Parameters:

value - the new scroll value

getVerticalSmallChange

public int getVerticalSmallChange()

Get the increment for clicking on an arrow on the vertical scrollbar.

Specified by:

getVerticalSmallChange in interface Scrollable

Returns:

the increment value

setVerticalSmallChange

public void setVerticalSmallChange(int smallChange)

Set the increment for clicking on an arrow on the vertical scrollbar.

Specified by:

setVerticalSmallChange in interface Scrollable

Parameters:

smallChange - the new increment value

getVerticalBigChange

public int getVerticalBigChange()

Get the increment for clicking in the bar between the box and an arrow on the vertical scrollbar.

Specified by:

getVerticalBigChange in interface Scrollable

Returns:

the increment value

setVerticalBigChange

public void setVerticalBigChange(int bigChange)

Set the increment for clicking in the bar between the box and an arrow on the vertical scrollbar.

Specified by:

setVerticalBigChange in interface Scrollable

Parameters:

bigChange - the new increment value

verticalDecrement

public void verticalDecrement()

Perform a small step change up.

Specified by:

verticalDecrement in interface Scrollable

verticalIncrement

public void verticalIncrement()

Perform a small step change down.

Specified by:

verticalIncrement in interface Scrollable

bigVerticalDecrement

public void bigVerticalDecrement()

Perform a big step change up.

Specified by:

bigVerticalDecrement in interface Scrollable

bigVerticalIncrement

public void bigVerticalIncrement()

Perform a big step change down.

Specified by:

bigVerticalIncrement in interface Scrollable

toTop

public void toTop()

Go to the top edge of the vertical scroller.

Specified by:

toTop in interface Scrollable

toBottom

public void toBottom()

Go to the bottom edge of the vertical scroller.

Specified by:

toBottom in interface Scrollable

getLeftValue

public int getLeftValue()

Get the value that corresponds to being on the left edge of the horizontal scroll bar.

Specified by:

getLeftValue in interface Scrollable

Returns:

the scroll value

setLeftValue

public void setLeftValue(int leftValue)

Set the value that corresponds to being on the left edge of the horizontal scroll bar.

Specified by:

setLeftValue in interface Scrollable

Parameters:

leftValue - the new scroll value

getRightValue

public int getRightValue()

Get the value that corresponds to being on the right edge of the horizontal scroll bar.

Specified by:

getRightValue in interface Scrollable

Returns:

the scroll value

setRightValue

public void setRightValue(int rightValue)

Set the value that corresponds to being on the right edge of the horizontal scroll bar.

Specified by:

setRightValue in interface Scrollable

Parameters:

rightValue - the new scroll value

getHorizontalValue

public int getHorizontalValue()

Get current value of the horizontal scroll.

Specified by:

getHorizontalValue in interface Scrollable

Returns:

the scroll value

setHorizontalValue

public void setHorizontalValue(int value)

Set current value of the horizontal scroll.

Specified by:

setHorizontalValue in interface Scrollable

Parameters:

value - the new scroll value

getHorizontalSmallChange

public int getHorizontalSmallChange()

Get the increment for clicking on an arrow on the horizontal scrollbar.

Specified by:

getHorizontalSmallChange in interface Scrollable

Returns:

the increment value

setHorizontalSmallChange

public void setHorizontalSmallChange(int smallChange)

Set the increment for clicking on an arrow on the horizontal scrollbar.

Specified by:

setHorizontalSmallChange in interface Scrollable

Parameters:

smallChange - the new increment value

getHorizontalBigChange

public int getHorizontalBigChange()

Get the increment for clicking in the bar between the box and an arrow on the horizontal scrollbar.

Specified by:

getHorizontalBigChange in interface Scrollable

Returns:

the increment value

setHorizontalBigChange

public void setHorizontalBigChange(int bigChange)

Set the increment for clicking in the bar between the box and an arrow on the horizontal scrollbar.

Specified by:

setHorizontalBigChange in interface Scrollable

Parameters:

bigChange - the new increment value

horizontalDecrement

public void horizontalDecrement()

Perform a small step change left.

Specified by:

horizontalDecrement in interface Scrollable

horizontalIncrement

public void horizontalIncrement()

Perform a small step change right.

Specified by:

horizontalIncrement in interface Scrollable

bigHorizontalDecrement

public void bigHorizontalDecrement()

Perform a big step change left.

Specified by:

bigHorizontalDecrement in interface Scrollable

bigHorizontalIncrement

public void bigHorizontalIncrement()

Perform a big step change right.

Specified by:

bigHorizontalIncrement in interface Scrollable

toLeft

public void toLeft()

Go to the left edge of the horizontal scroller.

Specified by:

toLeft in interface Scrollable

toRight

public void toRight()

Go to the right edge of the horizontal scroller.

Specified by:

toRight in interface Scrollable

toHome

public void toHome()

Go to the top-left edge of the horizontal and vertical scrollers.

Specified by:

toHome in interface Scrollable

toEnd

public void toEnd()

Go to the bottom-right edge of the horizontal and vertical scrollers.

Specified by:

toEnd in interface Scrollable

mouseOnVerticalScroller

protected final boolean mouseOnVerticalScroller(TMouseEvent mouse)

Check if a mouse press/release/motion event coordinate is over the vertical scrollbar.

Parameters:

mouse - a mouse-based event

Returns:

whether or not the mouse is on the scrollbar

mouseOnHorizontalScroller

protected final boolean mouseOnHorizontalScroller(TMouseEvent mouse)

Check if a mouse press/release/motion event coordinate is over the horizontal scrollbar.

Parameters:

mouse - a mouse-based event

Returns:

whether or not the mouse is on the scrollbar