com.bonzaiengine.ui.widget

Class TreeWidget<T>

java.lang.Object

com.bonzaiengine.ui.widget.Widget

com.bonzaiengine.ui.widget.Panel

com.bonzaiengine.ui.widget.TreeWidget<T>

All Implemented Interfaces:

IScrollable

public class TreeWidget<T>
extends Panel
implements IScrollable

Nested Class Summary

Nested classes/interfaces inherited from class com.bonzaiengine.ui.widget.Widget

Widget.NotifyEvent

Constructor Summary

Constructors

Constructor and Description
TreeWidget()

Method Summary

Modifier and Type	Method and Description
void	addTreeListener(TreeListener<T> l)
void	expandTo(Tree<T> node)
void	expandToSelection()
Tree<T>	findNode(T object)
Array<Tree<T>>	findNodes(Array<T> objects)
int	getInsetDecal()
int	getNumSelected()
TreeRendererDataProvider<T>	getRendererDataProvider()
Array<Tree<T>>	getSelection()
java.lang.Iterable<T>	getSelectionElements()
int	getStepForHorizontalScrolling()
int	getStepForVerticalScrolling()
boolean	isExpanded(Tree<T> node)
boolean	isExpandToSelection()
boolean	isRootVisible()
boolean	isSingleSelection()
boolean	removeTreeListener(TreeListener<T> listener)
void	select(java.lang.Iterable<Tree<T>> nodes, boolean unselectOthers)
void	select(Tree<T> node, boolean unselectOthers)
void	set(Tree<T> tree) Replace the entire tree structure and unselect all nodes
void	setExpanded(int level, boolean expanded)
boolean	setExpanded(Tree<T> node, boolean expanded)
void	setExpandToSelection(boolean expandToSelection)
void	setInsetDecal(int insetDecal)
void	setRendererDataProvider(TreeRendererDataProvider<T> dataProvider)
void	setRootVisible(boolean rootVisible)
void	setSingleSelection(boolean singleSelection)
void	unselectAll() Unselect of nodes
void	update() Refresh all the structure
boolean	update(Tree<T> node) Refresh a tree node

Methods inherited from class com.bonzaiengine.ui.widget.Panel

add, find, find, getLayout, getNumWidgets, getWidget, getWidget, isAccurateMouseOver, isOver, isOverlappingRendering, keyPressed, keyReleased, mouseDragged, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, remove, removeAll, setAccurateMouseOver, setLayout, setOverlappingRendering, update

Methods inherited from class com.bonzaiengine.ui.widget.Widget

addAnimator, addFocusListener, addKeyListener, addMouseFocusListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, focusTraversal, forceSize, getBackground, getBackgroundBorder, getBackgroundColor, getBackgroundFocus, getBackgroundOver, getBackgroundPress, getBorderSize, getConstraint, getDisableFade, getHeight, getHeightOnScreen, getInsets, getInsetsBottom, getInsetsHeight, getInsetsLeft, getInsetsRight, getInsetsTop, getInsetsWidth, getLocation, getLocationAnchor, getLocationOnScreen, getLocationRef, getLocationRef2, getLocationRefAnchor, getLocationX, getLocationXOnScreen, getLocationY, getLocationYOnScreen, getMaxHeight, getMaxWidth, getMenuPopup, getMinHeight, getMinHeightWidget, getMinWidth, getMinWidthWidget, getName, getOpacity, getParent, getPopup, getRoot, getStyle, getTooltip, getViewport, getViewportInternal, getWidth, getWidthOnScreen, hasFocus, isAutoPackHeight, isAutoPackWidth, isEnabled, isEnabledHerited, isEventsOnExternalDrag, isExternalDrag, isFocusable, isMouseDown, isMouseOver, isMouseOverOrDown, isVisible, isVisibleAndEnabledHerited, isVisibleHerited, mouseClicked, mouseEntered, mouseExited, refreshFocus, removeAnimator, removeFocusListener, removeKeyListener, removeMouseFocusListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, render, requestFocus, setAutoPack, setAutoPackHeight, setAutoPackWidth, setBackground, setBackgroundBorder, setBackgroundColor, setBackgroundFocus, setBackgroundOver, setBackgroundPress, setBorderSize, setCatchAllEvents, setDisableFade, setEnabled, setEventsOnExternalDrag, setExternalDrag, setFocusable, setFocusOwner, setInsets, setInsets, setLocation, setLocation, setLocationAnchor, setLocationAndAnchorInViewport, setLocationRef, setLocationRef2, setLocationRefAnchor, setMaxSize, setMaxSize, setMenuPopup, setMinSize, setMinSize, setName, setOpacity, setPopup, setSize, setSize, setStyle, setTooltip, setVisible, toString, uiFireAction

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TreeWidget

public TreeWidget()

Method Detail

set

public final void set(Tree<T> tree)

Replace the entire tree structure and unselect all nodes

Parameters:

tree - the tree data structure to set to this widget

See Also:

update()

update

public final void update()

Refresh all the structure

update

public final boolean update(Tree<T> node)

Refresh a tree node

Parameters:

node - notify the specified node may have structurally change

Returns:

true if the specified node

getStepForHorizontalScrolling

public final int getStepForHorizontalScrolling()

Specified by:

getStepForHorizontalScrolling in interface IScrollable

Returns:

the scroll step in pixels, or -1 if not applicable (use default instead)

getStepForVerticalScrolling

public final int getStepForVerticalScrolling()

Specified by:

getStepForVerticalScrolling in interface IScrollable

Returns:

the scroll step in pixels, or -1 if not applicable (use default instead)

findNode

public final Tree<T> findNode(T object)

Parameters:

object -

Returns:

findNodes

public final Array<Tree<T>> findNodes(Array<T> objects)

setExpanded

public final void setExpanded(int level,
                              boolean expanded)

setExpanded

public final boolean setExpanded(Tree<T> node,
                                 boolean expanded)

Parameters:

node -

expanded -

Returns:

true if succeed

isExpanded

public final boolean isExpanded(Tree<T> node)

expandTo

public final void expandTo(Tree<T> node)

expandToSelection

public final void expandToSelection()

select

public final void select(Tree<T> node,
                         boolean unselectOthers)

Parameters:

node - node to selected

unselectOthers - true to unselect other nodes (ignored if isSingleSelection() is true

select

public final void select(java.lang.Iterable<Tree<T>> nodes,
                         boolean unselectOthers)

Parameters:

nodes -

unselectOthers - true to unselect other nodes (ignored if isSingleSelection() is true

unselectAll

public final void unselectAll()

Unselect of nodes

setRendererDataProvider

public final void setRendererDataProvider(TreeRendererDataProvider<T> dataProvider)

getRendererDataProvider

public final TreeRendererDataProvider<T> getRendererDataProvider()

getSelection

public Array<Tree<T>> getSelection()

Returns:

the current selection in a new array

See Also:

getSelectionElements()

getSelectionElements

public java.lang.Iterable<T> getSelectionElements()

Returns:

the current selection

See Also:

getSelection()

getNumSelected

public final int getNumSelected()

Returns:

the number of node selected

addTreeListener

public final void addTreeListener(TreeListener<T> l)

Parameters:

l - listener to register to this widget

removeTreeListener

public final boolean removeTreeListener(TreeListener<T> listener)

setRootVisible

public final void setRootVisible(boolean rootVisible)

isRootVisible

public final boolean isRootVisible()

Returns:

true if the root node is visible (false by default)

setSingleSelection

public final void setSingleSelection(boolean singleSelection)

Parameters:

singleSelection - true to allow only one tree item selectable

isSingleSelection

public final boolean isSingleSelection()

setInsetDecal

public final void setInsetDecal(int insetDecal)

getInsetDecal

public final int getInsetDecal()

Returns:

setExpandToSelection

public final void setExpandToSelection(boolean expandToSelection)

isExpandToSelection

public final boolean isExpandToSelection()