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

Field Summary

Fields

Modifier and Type	Field and Description
protected com.bonzaiengine.ui.widget.TreeWidgetItem<T>	lastSelected
protected com.bonzaiengine.ui.widget.TreeWidgetItem<T>	root

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

COMMAND_KEY_ENTER, COMMAND_MOUSE_CLICK, COMMAND_UNKNOWN, culled, fontChangeId, fontName, fontSize, lastFont, lastFontSize, RENDER_BACKGROUND, RENDER_FOREGROUND

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)
protected com.bonzaiengine.ui.widget.TreeWidgetItem<T>	findNode(com.bonzaiengine.ui.widget.TreeWidgetItem<T> widget, Tree<T> node)
Array<Tree<T>>	findNodes(Array<T> objects)
protected boolean	fireOnNodeAction(Tree<T> node, Widget w)
protected boolean	fireOnNodeMouseEvent(MouseEvent e, Tree<T> node, Widget w)
protected void	fireSelectionChanged()
int	getNumSelected()
Array<Tree<T>>	getSelection()
java.lang.Iterable<T>	getSelectionElements()
int	getStepForHorizontalScrolling()
int	getStepForVerticalScrolling()
boolean	isExpanded(Tree<T> node)
protected boolean	onKeyPressed(UI ui, KeyEvent e)
protected boolean	onNodeAction(Tree<T> node, Widget w)
protected boolean	onNodeMouseEvent(MouseEvent e, Tree<T> node, Widget w)
protected void	onSelectionChanged()
protected void	onShowPopup(int x, int y)
boolean	removeTreeListener(TreeListener<T> listener)
void	select(java.lang.Iterable<Tree<T>> nodes, boolean unselectOthers)
void	select(Tree<T> node, boolean unselectOthers)
protected boolean	selectInterval(com.bonzaiengine.ui.widget.TreeWidgetItem<T> start, com.bonzaiengine.ui.widget.TreeWidgetItem<T> end)
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	setRootVisible(boolean rootVisible)
protected boolean	setSelected(com.bonzaiengine.ui.widget.TreeWidgetItem<T> node, boolean select, boolean ignoreExpand, boolean multipleSelection)
void	unselectAll() Unselect of nodes
protected boolean	unselectAll(com.bonzaiengine.ui.widget.TreeWidgetItem<T> item)
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, addNoNotify, dispatchKeyEvent, dispatchMouseExited, dispatchMouseMoved, dispatchMousePressed, dispatchMouseReleased, dispatchMouseWheelMoved, doMoveOpti, find, focusableTraversal, focusableTraversalDown, getNumWidgets, getWidget, getWidget, hasMenuPopupVisible, indexOf, insert, isOver, isOverlappingRendering, notifyEvent, onChildChanged, remove, remove, removeAll, removeAll, renderGL, renderGLAfterBackground, resolveLayout, setLayout, traverse, update, updateChilds, updateMinViewport

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

addActionListener, addAnimator, addChangeListener, addFocusListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bindTo, contains, delayNotifyEvent, dispatchNotifyEvent, dispatchShowPopup, find, fireAction, fireAnimator, fireChange, fireKeyEvent, fireMouseEvent, focusableTraversalUp, focusTraversal, forceSize, getCurrentBackground, getCurrentBackgroundColor, getFocusable, getFontSizeForRender, getHeightOnScreen, getInsets, getInsetsHeight, getInsetsWidth, getLocation, getLocationOnScreen, getLocationXOnScreen, getLocationYOnScreen, getMenuPopup, getMinHeightLayout, getMinHeightWidget, getMinWidthLayout, getMinWidthWidget, getPopup, getPreferredHeight, getPreferredWidth, getRefBackground, getRoot, getTooltip, getViewportBorderBottom, getViewportBorderHeight, getViewportBorderLeft, getViewportBorderWidth, getWidthOnScreen, hasFocus, hasKeyEventFocus, isBackgroundOpaque, isDownOrMouseDown, isFocusable, isFree, isMouseOverOrDown, isRenderingAndEnabled, onActionPerformed, onDiscardState, onFocusChanged, onFontChanged, onKeyReleased, onMouseClicked, onMouseDownDragUp, onMouseDragged, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onMouseWheelMoved, onMove, onParentChanged, onStateChanged, onStyleChanged, refreshFocus, removeActionListener, removeAllActionListener, removeAnimator, removeChangeListener, removeFocusListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, render, requestFocus, resolveBlockEvents, resolveLocationRef, setAutoPack, setAutoPackHeight, setAutoPackWidth, setBackgroundColor, setDown, setEnabled, setFocusable, setInsets, setInsets, setIsBackground, setLocation, setLocation, setLocationAnchor, setLocationRef, setLocationRef2, setLocationRefAnchor, setMaxSize, setMaxSize, setMenuPopup, setMinSize, setMinSize, setMinSizeLayout, setParent, setPopup, setSize, setSize, setSizeOnScreen, setStyle, setTooltip, setVisible, toString, triggerChildsUpdate, uiFireAction, updateListenersForPosition

Methods inherited from class java.lang.Object

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

Field Detail

root

protected com.bonzaiengine.ui.widget.TreeWidgetItem<T> root

lastSelected

protected com.bonzaiengine.ui.widget.TreeWidgetItem<T> lastSelected

Constructor Detail

TreeWidget

public TreeWidget()

Method Detail

onKeyPressed

protected boolean onKeyPressed(UI ui,
                               KeyEvent e)

Overrides:

onKeyPressed in class Widget

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

protected final com.bonzaiengine.ui.widget.TreeWidgetItem<T> findNode(com.bonzaiengine.ui.widget.TreeWidgetItem<T> widget,
                                                                      Tree<T> node)

Returns:

the TreeItem containing the specified node, null if not found

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

selectInterval

protected final boolean selectInterval(com.bonzaiengine.ui.widget.TreeWidgetItem<T> start,
                                       com.bonzaiengine.ui.widget.TreeWidgetItem<T> end)

setSelected

protected final boolean setSelected(com.bonzaiengine.ui.widget.TreeWidgetItem<T> node,
                                    boolean select,
                                    boolean ignoreExpand,
                                    boolean multipleSelection)

unselectAll

public final void unselectAll()

Unselect of nodes

unselectAll

protected final boolean unselectAll(com.bonzaiengine.ui.widget.TreeWidgetItem<T> item)

fireSelectionChanged

protected final void fireSelectionChanged()

onSelectionChanged

protected void onSelectionChanged()

fireOnNodeAction

protected final boolean fireOnNodeAction(Tree<T> node,
                                         Widget w)

onNodeAction

protected boolean onNodeAction(Tree<T> node,
                               Widget w)

fireOnNodeMouseEvent

protected final boolean fireOnNodeMouseEvent(MouseEvent e,
                                             Tree<T> node,
                                             Widget w)

onNodeMouseEvent

protected boolean onNodeMouseEvent(MouseEvent e,
                                   Tree<T> node,
                                   Widget w)

onShowPopup

protected void onShowPopup(int x,
                           int y)

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)