public Class TextFieldTreeCell<T>

Overrides javafx.scene.control.TreeCell.cancelEdit.

Doc from javafx.scene.control.TreeCell.cancelEdit.

Cancels an edit to the value of the cell. Call this function to transition from an editing state into a non-editing state, without saving any user input.

Annotations

@Override

The StringConverter property.

Returns:ObjectProperty<StringConverter<T>>

the StringConverter property

Provides a TextField that allows editing of the cell content when the cell is double-clicked, or when TreeView#edit(javafx.scene.control.TreeItem) is called. This method will only work on TreeView instances which are of type String.

Returns:Callback<TreeView<String>, TreeCell<String>>

A Callback that can be inserted into the cell factory property of a TreeView, that enables textual editing of the content.

Provides a TextField that allows editing of the cell content when the cell is double-clicked, or when TreeView#edit(javafx.scene.control.TreeItem) is called. This method will work on any TreeView instance, regardless of its generic type. However, to enable this, a StringConverter must be provided that will convert the given String (from what the user typed in) into an instance of type T. This item will then be passed along to the TreeView#onEditCommitProperty() callback.

Parameters

<T>

The type of the elements contained within the TreeView

converter:StringConverter<T>

A StringConverter that can convert the given String (from what the user typed in) into an instance of type T.

Returns:Callback<TreeView<T>, TreeCell<T>>

A Callback that can be inserted into the cell factory property of a TreeView, that enables textual editing of the content.

Returns the StringConverter used in this cell.

Returns:StringConverter<T>

the StringConverter used in this cell

Sets the StringConverter to be used in this cell.

Parameters

value:StringConverter<T>

the StringConverter to be used in this cell

Overrides javafx.scene.control.TreeCell.startEdit.

Doc from javafx.scene.control.TreeCell.startEdit.

Starts an edit to the value of the cell. Call this function to transition from a non-editing state into an editing state, if the cell is editable. If this cell is already in an editing state, it will stay in it.

Annotations

@Override

Overrides javafx.scene.control.cell.DefaultTreeCell.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