org.jowidgets.api.widgets

Interface ITreeNode

All Superinterfaces:

IDisposeObservable, IItem, IItemCommon, IKeyObservable, IPopupDetectionObservable, ITreeContainer, ITreeNodeCheckableObservable, ITreeNodeCommon, ITreeNodeObservable, IWidget, IWidgetCommon

public interface ITreeNode
extends IItem, ITreeContainer, ITreeNodeCheckableObservable, IKeyObservable, ITreeNodeCommon

Method Summary

Methods

Modifier and Type	Method and Description
IPopupMenu	createPopupMenu()
CheckedState	getCheckedState()
ITreeNode	getParent() Gets the parent of the widget
java.util.List<ITreeNode>	getPath()
ITree	getTree()
boolean	isCheckable()
boolean	isLeaf()
boolean	isTopLevel()
boolean	isUnchecked() Checks if node is unchecked.
void	setCheckedState(CheckedState state)
void	setGreyed() Sets the node to the greyed state.
void	setPopupMenu(IMenuModel popupMenu) Sets a popup menu for this node.

Methods inherited from interface org.jowidgets.api.widgets.IItem

getIcon, getText, getToolTipText

Methods inherited from interface org.jowidgets.api.widgets.IWidget

dispose, getRoot, isDisposed

Methods inherited from interface org.jowidgets.api.controller.IDisposeObservable

addDisposeListener, removeDisposeListener

Methods inherited from interface org.jowidgets.api.widgets.ITreeContainer

accept, addNode, addNode, addNode, addNode, getChildren, getLevel, getParentContainer, removeAllNodes, removeNode, removeNode, setAllChildrenBelowExpandedAboveCollapsed, setAllChildrenChecked, setAllChildrenExpanded, setAllChildrenExpanded

Methods inherited from interface org.jowidgets.api.controller.ITreeNodeCheckableObservable

addCheckableListener, removeCheckableListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IKeyObservable

addKeyListener, removeKeyListener

Methods inherited from interface org.jowidgets.common.widgets.ITreeNodeCommon

isChecked, isExpanded, isGreyed, isSelected, setBackgroundColor, setCheckable, setChecked, setExpanded, setForegroundColor, setMarkup, setSelected

Methods inherited from interface org.jowidgets.common.widgets.IItemCommon

setIcon, setText, setToolTipText

Methods inherited from interface org.jowidgets.common.widgets.IWidgetCommon

getUiReference, isEnabled, setEnabled

Methods inherited from interface org.jowidgets.common.widgets.controller.ITreeNodeObservable

addTreeNodeListener, removeTreeNodeListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IPopupDetectionObservable

addPopupDetectionListener, removePopupDetectionListener

Method Detail

getTree

ITree getTree()

Returns:

The tree this node belongs to

isLeaf

boolean isLeaf()

Returns:

True if this node is a leaf (has no children), false otherwise.

isTopLevel

boolean isTopLevel()

Returns:

True if this node is a top level node (has no parent), false otherwise

getPath

java.util.List<ITreeNode> getPath()

Returns:

Gets the path from the top level parent of this node to this node (this node is included into the path)

createPopupMenu

IPopupMenu createPopupMenu()

Returns:

A IPopupMenu for this node

setPopupMenu

void setPopupMenu(IMenuModel popupMenu)

Sets a popup menu for this node. The popup menu will be shown, when an popup event occurs on this node.

Parameters:

menuModel - The model of the popup menu or null, if no popup should be shown on popup events

getParent

ITreeNode getParent()

Description copied from interface: IWidget

Gets the parent of the widget

Specified by:

getParent in interface IWidget

Returns:

The widgets parent or null, if the widget has no parent

getCheckedState

CheckedState getCheckedState()

setCheckedState

void setCheckedState(CheckedState state)

setGreyed

void setGreyed()

Sets the node to the greyed state. If set, the isChecked() and isUnchecked() methods will return false both, and the isGreyed() method will return true

isUnchecked

boolean isUnchecked()

Checks if node is unchecked. If true it is not checked and not greyed, if false it my be greyed or checked

Returns:

The unchecked state

isCheckable

boolean isCheckable()