APIdia Launch Partner
Top Fields Constructors Methods
javafx.scene.control.cell

pack-priv Class DefaultTreeCell<T>

extends TreeCell<T>
Class Inheritance
Known Direct Subclasses
javafx.scene.control.cell.TextFieldTreeCell, javafx.scene.control.cell.CheckBoxTreeCell, javafx.scene.control.cell.ChoiceBoxTreeCell, javafx.scene.control.cell.ComboBoxTreeCell
Imports
javafx.beans.InvalidationListener, .Observable, .WeakInvalidationListener, javafx.scene.Node, javafx.scene.control.TreeCell, .TreeItem, javafx.scene.layout.HBox, java.lang.ref.WeakReference

Field Summary

Modifier and TypeField and Description
private HBox
private InvalidationListener
private InvalidationListener
private WeakReference<TreeItem<T>>
private WeakInvalidationListener
private WeakInvalidationListener

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
pack-priv void
updateDisplay(T item, boolean empty)

public void
updateItem(T item, boolean empty)

Overrides javafx.scene.control.Cell.updateItem.

The updateItem method should not be called by developers, but it is the best method for developers to override to allow for them to customise the visuals of the cell.

Inherited from javafx.scene.control.TreeCell:
cancelEditcommitEditcreateDefaultSkindisclosureNodePropertyexecuteAccessibleActiongetDisclosureNodegetTreeItemgetTreeViewqueryAccessibleAttributesetDisclosureNodestartEdittreeItemPropertytreeViewPropertyupdateTreeItemupdateTreeView

Field Detail

hboxback to summary
private HBox hbox
treeItemGraphicListenerback to summary
private InvalidationListener treeItemGraphicListener
treeItemListenerback to summary
private InvalidationListener treeItemListener
treeItemRefback to summary
private WeakReference<TreeItem<T>> treeItemRef
weakTreeItemGraphicListenerback to summary
private WeakInvalidationListener weakTreeItemGraphicListener
weakTreeItemListenerback to summary
private WeakInvalidationListener weakTreeItemListener

Constructor Detail

DefaultTreeCellback to summary
public DefaultTreeCell()

Method Detail

updateDisplayback to summary
pack-priv void updateDisplay(T item, boolean empty)
updateItemback to summary
public void updateItem(T item, boolean empty)

Overrides javafx.scene.control.Cell.updateItem.

Doc from javafx.scene.control.Cell.updateItem.

The updateItem method should not be called by developers, but it is the best method for developers to override to allow for them to customise the visuals of the cell. To clarify, developers should never call this method in their code (they should leave it up to the UI control, such as the javafx.scene.control.ListView control) to call this method. However, the purpose of having the updateItem method is so that developers, when specifying custom cell factories (again, like the ListView cell factory), the updateItem method can be overridden to allow for complete customisation of the cell.

It is very important that subclasses of Cell override the updateItem method properly, as failure to do so will lead to issues such as blank cells or cells with unexpected content appearing within them. Here is an example of how to properly override the updateItem method:

protected void updateItem(T item, boolean empty) {
    super.updateItem(item, empty);

    if (empty || item == null) {
        setText(null);
        setGraphic(null);
    } else {
        setText(item.toString());
    }
}

Note in this code sample two important points:

  1. We call the super.updateItem(T, boolean) method. If this is not done, the item and empty properties are not correctly set, and you are likely to end up with graphical issues.
  2. We test for the empty condition, and if true, we set the text and graphic properties to null. If we do not do this, it is almost guaranteed that end users will see graphical artifacts in cells unexpectedly.
Annotations
@Override