Package jexer.ttree

Class TTreeViewWidget

java.lang.Object

jexer.TWidget

jexer.TScrollableWidget

jexer.ttree.TTreeViewWidget

All Implemented Interfaces:

java.lang.Comparable<TWidget>, Scrollable

public class TTreeViewWidget
extends TScrollableWidget

TTreeViewWidget wraps a tree view with horizontal and vertical scrollbars.

Field Summary

Fields inherited from class jexer.TScrollableWidget

hScroller, vScroller

Constructor Summary

Constructors

Constructor	Description
TTreeViewWidget(TWidget parent, int x, int y, int width, int height)	Public constructor.
TTreeViewWidget(TWidget parent, int x, int y, int width, int height, TAction action)	Public constructor.

Method Summary

Modifier and Type	Method	Description
void	dispatch()	Perform user selection action.
TTreeItem	getSelected()	Get the tree view item that was selected.
TTreeItem	getTreeRoot()	Get the root of the tree.
TTreeView	getTreeView()	Get the underlying TTreeView.
void	onKeypress(TKeypressEvent keypress)	Handle keystrokes.
void	onMouseDown(TMouseEvent mouse)	Handle mouse press events.
void	onMouseMotion(TMouseEvent mouse)	Handle mouse motion events.
void	onMouseUp(TMouseEvent mouse)	Handle mouse release events.
void	onResize(TResizeEvent event)	Handle window/screen resize events.
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	setSelected(TTreeItem item, boolean centerWindow)	Set the new selected tree view item.
void	setTreeRoot(TTreeItem treeRoot)	Set the root of the tree.
void	setTreeRoot(TTreeItem treeRoot, boolean centerWindow)	Set treeRoot.
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, placeScrollbars, 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, 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, draw, 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, putAll, putAttrXY, putAttrXY, putCharXY, putCharXY, putCharXY, putStringXY, putStringXY, remove, remove, remove, remove, removeAll, resetTabOrder, setActive, setCursorVisible, setCursorX, setCursorY, setCustomMousePointer, setDimensions, setEchoKeystrokes, setEchoKeystrokes, setEnabled, 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

TTreeViewWidget

public TTreeViewWidget(TWidget parent,
                       int x,
                       int y,
                       int width,
                       int height)

Public constructor.

Parameters:

parent - parent widget

x - column relative to parent

y - row relative to parent

width - width of tree view

height - height of tree view

TTreeViewWidget

public TTreeViewWidget(TWidget parent,
                       int x,
                       int y,
                       int width,
                       int height,
                       TAction action)

Public constructor.

Parameters:

parent - parent widget

x - column relative to parent

y - row relative to parent

width - width of tree view

height - height of tree view

action - action to perform when an item is selected

Method Detail

onResize

public void onResize(TResizeEvent event)

Handle window/screen resize events.

Overrides:

onResize in class TScrollableWidget

Parameters:

event - resize event

onMouseDown

public void onMouseDown(TMouseEvent mouse)

Handle mouse press events.

Overrides:

onMouseDown in class TWidget

Parameters:

mouse - mouse button press event

onMouseUp

public void onMouseUp(TMouseEvent mouse)

Handle mouse release events.

Overrides:

onMouseUp in class TWidget

Parameters:

mouse - mouse button release event

onMouseMotion

public void onMouseMotion(TMouseEvent mouse)

Handle mouse motion events.

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

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.

Overrides:

setHeight in class TWidget

Parameters:

height - new widget height

reflowData

public void reflowData()

Resize text and scrollbars for a new width/height.

Overrides:

reflowData in class TScrollableWidget

getTreeView

public TTreeView getTreeView()

Get the underlying TTreeView.

Returns:

the TTreeView

getTreeRoot

public final TTreeItem getTreeRoot()

Get the root of the tree.

Returns:

the root of the tree

setTreeRoot

public final void setTreeRoot(TTreeItem treeRoot)

Set the root of the tree.

Parameters:

treeRoot - the new root of the tree

setTreeRoot

public void setTreeRoot(TTreeItem treeRoot,
                        boolean centerWindow)

Set treeRoot.

Parameters:

treeRoot - ultimate root of tree

centerWindow - if true, move the window to put the root in view

getSelected

public final TTreeItem getSelected()

Get the tree view item that was selected.

Returns:

the selected item, or null if no item is selected

setSelected

public void setSelected(TTreeItem item,
                        boolean centerWindow)

Set the new selected tree view item.

Parameters:

item - new item that became selected

centerWindow - if true, move the window to put the selected into view

dispatch

public void dispatch()

Perform user selection action.