org.eclipse.fx.ui.controls.tree

Class SortableTreeItem<T>

java.lang.Object

javafx.scene.control.TreeItem<T>

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

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

Type Parameters:

T - The type of the value property within TreeItem.

All Implemented Interfaces:

javafx.event.EventTarget

public class SortableTreeItem<T>
extends FilterableTreeItem<T>

An extension of TreeItem with the possibility to sort its 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.

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<TreeItemComparator<T>>	comparator

Properties inherited from class org.eclipse.fx.ui.controls.tree.FilterableTreeItem

predicateProperty

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
SortableTreeItem(T value) Creates a new TreeItem with sorted children.

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.ObjectProperty<TreeItemComparator<T>>	comparatorProperty()
javafx.collections.ObservableList<javafx.scene.control.TreeItem<T>>	getChildren() This method overrides TreeItem.getChildren() and returns an unmodifiable SortedList as the children may only be changed via the underlying model.
TreeItemComparator<T>	getComparator()
void	setComparator(TreeItemComparator<T> comparator) Set the comparator

Methods inherited from class org.eclipse.fx.ui.controls.tree.FilterableTreeItem

getInternalChildren, getPredicate, isLeaf, predicateProperty, setPredicate

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

comparator

public final javafx.beans.property.ObjectProperty<TreeItemComparator<T>> comparatorProperty

See Also:

getComparator(), setComparator(TreeItemComparator)

Constructor Detail

SortableTreeItem

public SortableTreeItem(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 SortedList as the children may only be changed via the underlying model.

Overrides:

getChildren in class FilterableTreeItem<T>

See Also:

FilterableTreeItem.getInternalChildren()

comparatorProperty

public final javafx.beans.property.ObjectProperty<TreeItemComparator<T>> comparatorProperty()

See Also:

getComparator(), setComparator(TreeItemComparator)

getComparator

public final TreeItemComparator<T> getComparator()

Returns:

the comparator

setComparator

public final void setComparator(TreeItemComparator<T> comparator)

Set the comparator

Parameters:

comparator - the comparator