Top Description Fields Constructors Methods
javafx.scene.control.cell

public Class TextFieldTreeCell<T>

extends DefaultTreeCell<T>
Class Inheritance
Type Parameters
<T>
The type of the elements contained within the TreeView.
Imports
javafx.beans.property.ObjectProperty, .SimpleObjectProperty, javafx.scene.Node, javafx.scene.control.Label, .TextField, .TreeCell, .TreeItem, .TreeView, javafx.scene.layout.HBox, javafx.util.Callback, .StringConverter, javafx.util.converter.DefaultStringConverter
A class containing a TreeCell implementation that draws a TextField node inside the cell.

By default, the TextFieldTreeCell is rendered as a Label when not being edited, and as a TextField when in editing mode. The TextField will, by default, stretch to fill the entire tree cell.

Since
JavaFX 2.2

Field Summary

Modifier and TypeField and Description
private ObjectProperty<StringConverter<T>>
converter

private HBox
hbox

Hides javafx.scene.control.cell.DefaultTreeCell.hbox.

private TextField
textField

Constructor Summary

AccessConstructor and Description
public
TextFieldTreeCell()

Creates a default TextFieldTreeCell with a null converter.

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

Creates a TextFieldTreeCell that provides a TextField when put into editing mode that allows editing of the cell content.

Method Summary

Modifier and TypeMethod and Description
public void
cancelEdit()

Overrides javafx.scene.control.TreeCell.cancelEdit.

Cancels an edit to the value of the cell.

public final ObjectProperty<StringConverter<T>>

Returns:

the StringConverter property
converterProperty()

The StringConverter property.

public static Callback<TreeView<String>, TreeCell<String>>

Returns:

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

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.

public static <
The type of the elements contained within the TreeView
T> Callback<TreeView<T>, TreeCell<T>>

Returns:

A Callback that can be inserted into the cell factory property of a TreeView, that enables textual editing of the content.
forTreeView(final StringConverter<T>
A StringConverter that can convert the given String (from what the user typed in) into an instance of type T.
converter)

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.

public final StringConverter<T>

Returns:

the StringConverter used in this cell
getConverter()

Returns the StringConverter used in this cell.

private Node
getTreeItemGraphic()

public final void
setConverter(StringConverter<T>
the StringConverter to be used in this cell
value)

Sets the StringConverter to be used in this cell.

public void
startEdit()

Overrides javafx.scene.control.TreeCell.startEdit.

Starts an edit to the value of the cell.

public void
updateItem(T
The new item for the cell.
item, boolean
whether or not this cell represents data from the list. If it is empty, then it does not represent any domain data, but is a cell being used to render an "empty" row.
empty)

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

Field Detail

converterback to summary
private ObjectProperty<StringConverter<T>> converter
hboxback to summary
private HBox hbox

Hides javafx.scene.control.cell.DefaultTreeCell.hbox.

textFieldback to summary
private TextField textField

Constructor Detail

TextFieldTreeCellback to summary
public TextFieldTreeCell()

Creates a default TextFieldTreeCell with a null converter. Without a StringConverter specified, this cell will not be able to accept input from the TextField (as it will not know how to convert this back to the domain object). It is therefore strongly encouraged to not use this constructor unless you intend to set the converter separately.

TextFieldTreeCellback to summary
public TextFieldTreeCell(StringConverter<T> converter)

Creates a TextFieldTreeCell that provides a TextField when put into editing mode that allows editing of the cell content. 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
converter:StringConverter<T>

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

Method Detail

cancelEditback to summary
public void cancelEdit()

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
converterPropertyback to summary
public final ObjectProperty<StringConverter<T>> converterProperty()

The StringConverter property.

Returns:ObjectProperty<StringConverter<T>>

the StringConverter property

forTreeViewback to summary
public static Callback<TreeView<String>, TreeCell<String>> forTreeView()

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.

forTreeViewback to summary
public static <T> Callback<TreeView<T>, TreeCell<T>> forTreeView(final StringConverter<T> converter)

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.

getConverterback to summary
public final StringConverter<T> getConverter()

Returns the StringConverter used in this cell.

Returns:StringConverter<T>

the StringConverter used in this cell

getTreeItemGraphicback to summary
private Node getTreeItemGraphic()
setConverterback to summary
public final void setConverter(StringConverter<T> value)

Sets the StringConverter to be used in this cell.

Parameters
value:StringConverter<T>

the StringConverter to be used in this cell

startEditback to summary
public void startEdit()

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
updateItemback to summary
public void updateItem(T item, boolean empty)

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.
Parameters
item:T

The new item for the cell.

empty:boolean

whether or not this cell represents data from the list. If it is empty, then it does not represent any domain data, but is a cell being used to render an "empty" row.

Annotations
@Override