org.eclipse.fx.ui.controls.tree

Class CheckedTreeItemCollector<T>

java.lang.Object

org.eclipse.fx.ui.controls.tree.CheckedTreeItemCollector<T>

Type Parameters:

T - The type of the value property within TreeItem.

public class CheckedTreeItemCollector<T>
extends java.lang.Object

This class provides the possibility to collect all the values of "checked" tree items of any root CheckBoxTreeItem. This collection is presented as a flat ObservableSet. The "checked" state of a tree item can be modified, by adding or removing its value from getCheckedItems().

Constructor Summary

Constructors

Constructor and Description
CheckedTreeItemCollector(javafx.scene.control.CheckBoxTreeItem<T> root)

Method Summary

Modifier and Type	Method and Description
void	checkAll() Check all the items in the tree
javafx.collections.ObservableSet<T>	getCheckedItems()
void	uncheckAll() Uncheck all the items in the tree

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckedTreeItemCollector

public CheckedTreeItemCollector(javafx.scene.control.CheckBoxTreeItem<T> root)

Parameters:

root - The "checked" state of all the descendants, including the root itself, will be monitored

Method Detail

checkAll

public void checkAll()

Check all the items in the tree

uncheckAll

public void uncheckAll()

Uncheck all the items in the tree

getCheckedItems

public javafx.collections.ObservableSet<T> getCheckedItems()

Returns:

An ObservableSet of all the values who's tree items have been "checked"