org.eclipse.fx.ui.controls.tree

Class FilterableTreeItem<T>

java.lang.Object

javafx.scene.control.TreeItem<T>

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

Type Parameters:

T - The type of the value property within TreeItem.

All Implemented Interfaces:

javafx.event.EventTarget

Direct Known Subclasses:

SortableTreeItem

public class FilterableTreeItem<T>
extends javafx.scene.control.TreeItem<T>

An extension of TreeItem with the possibility to filter its children. To enable filtering it is necessary to set the TreeItemPredicate. If a predicate is set, then the tree item will also use this predicate to filter its children (if they are of the type FilterableTreeItem). A tree item that has children will not be filtered. The predicate will only be evaluated, if the tree item is a leaf. Since the predicate is also set for the child tree items, the tree item in question can turn into a leaf if all its children are filtered.

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<TreeItemPredicate<T>>	predicate

Properties inherited from class javafx.scene.control.TreeItem

expandedProperty, graphicProperty, leafProperty, parentProperty, valueProperty

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.control.TreeItem

javafx.scene.control.TreeItem.TreeModificationEvent<T>

Constructor Summary

Constructors

Constructor and Description
FilterableTreeItem(T value) Creates a new TreeItem with sorted children.

Method Summary

Modifier and Type	Method and Description
javafx.collections.ObservableList<javafx.scene.control.TreeItem<T>>	getChildren() This method overrides TreeItem.getChildren() and returns an unmodifiable FilteredList as the children may only be changed via the underlying model.
javafx.collections.ObservableList<javafx.scene.control.TreeItem<T>>	getInternalChildren() Returns the list of children that is backing the filtered list.
TreeItemPredicate<T>	getPredicate()
boolean	isLeaf()
javafx.beans.property.ObjectProperty<TreeItemPredicate<T>>	predicateProperty()
void	setPredicate(TreeItemPredicate<T> predicate) Set the predicate

Methods inherited from class javafx.scene.control.TreeItem

addEventHandler, branchCollapsedEvent, branchExpandedEvent, buildEventDispatchChain, childrenModificationEvent, expandedItemCountChangeEvent, expandedProperty, getGraphic, getParent, getValue, graphicChangedEvent, graphicProperty, isExpanded, leafProperty, nextSibling, nextSibling, parentProperty, previousSibling, previousSibling, removeEventHandler, setExpanded, setGraphic, setValue, toString, treeNotificationEvent, valueChangedEvent, valueProperty

Methods inherited from class java.lang.Object

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

Property Detail

predicate

public final javafx.beans.property.ObjectProperty<TreeItemPredicate<T>> predicateProperty

See Also:

getPredicate(), setPredicate(TreeItemPredicate)

Constructor Detail

FilterableTreeItem

public FilterableTreeItem(T value)

Creates a new TreeItem with sorted children. To enable sorting it is necessary to set the TreeItemComparator. If no comparator is set, then the tree item will attempt so bind itself to the comparator of its parent.

Parameters:

value - the value of the TreeItem

Method Detail

getChildren

public javafx.collections.ObservableList<javafx.scene.control.TreeItem<T>> getChildren()

This method overrides TreeItem.getChildren() and returns an unmodifiable FilteredList as the children may only be changed via the underlying model.

Overrides:

getChildren in class javafx.scene.control.TreeItem<T>

See Also:

getInternalChildren()

getInternalChildren

public javafx.collections.ObservableList<javafx.scene.control.TreeItem<T>> getInternalChildren()

Returns the list of children that is backing the filtered list.

Returns:

underlying list of children

isLeaf

public boolean isLeaf()

Overrides:

isLeaf in class javafx.scene.control.TreeItem<T>

predicateProperty

public final javafx.beans.property.ObjectProperty<TreeItemPredicate<T>> predicateProperty()

See Also:

getPredicate(), setPredicate(TreeItemPredicate)

getPredicate

public final TreeItemPredicate<T> getPredicate()

Returns:

the predicate

setPredicate

public final void setPredicate(TreeItemPredicate<T> predicate)

Set the predicate

Parameters:

predicate - the predicate