JavaFX 27 · javafx.scene.control.cell.ComboBoxTreeCell

Modifier and Type	Field and Description
private ComboBox<T>	comboBox
private BooleanProperty	comboBoxEditable
private ObjectProperty<StringConverter<T>>	converter
private HBox	hbox Hides javafx.scene.control.cell.DefaultTreeCell.hbox.
private final ObservableList<T>	items

Constructor Summary

Access	Constructor and Description
public	ComboBoxTreeCell() Creates a default ComboBoxTreeCell with an empty items list.
public	ComboBoxTreeCell(T... The items to show in the ComboBox popup menu when selected by the user. items) Creates a default `ComboBoxTreeCell` instance with the given items being used to populate the `ComboBox` when it is shown.
public	ComboBoxTreeCell(StringConverter<T> A `StringConverter` that can convert an item of type T into a user-readable string so that it may then be shown in the ComboBox popup menu. converter, T... The items to show in the ComboBox popup menu when selected by the user. items) Creates a `ComboBoxTreeCell` instance with the given items being used to populate the `ComboBox` when it is shown, and the `StringConverter` being used to convert the item in to a user-readable form.
public	ComboBoxTreeCell(ObservableList<T> The items to show in the ComboBox popup menu when selected by the user. items) Creates a default `ComboBoxTreeCell` instance with the given items being used to populate the `ComboBox` when it is shown.
public	ComboBoxTreeCell(StringConverter<T> A `StringConverter` that can convert an item of type T into a user-readable string so that it may then be shown in the ComboBox popup menu. converter, ObservableList<T> The items to show in the ComboBox popup menu when selected by the user. items) Creates a `ComboBoxTreeCell` instance with the given items being used to populate the `ComboBox` when it is shown, and the `StringConverter` being used to convert the item in to a user-readable form.

Method Summary

Modifier and Type	Method and Description
public void	cancelEdit() Overrides javafx.scene.control.TreeCell.cancelEdit. Cancels an edit to the value of the cell.
public final BooleanProperty	Returns: the property representing whether the ComboBox, when shown to the user, is editable or not comboBoxEditableProperty() A property representing whether the ComboBox, when shown to the user, is editable or not.
public final ObjectProperty<StringConverter<T>>	Returns: the `StringConverter` property converterProperty() The `StringConverter` property.
public static < The type of the elements contained within the TreeView. T> Callback<TreeView<T>, TreeCell<T>>	Returns: A `Callback` that will return a TreeCell that is able to work on the type of element contained within the TreeView. forTreeView(T... Zero or more items that will be shown to the user when the `ComboBox` menu is showing. These items must be of the same type as the TreeView<T>, such that upon selection, they replace the existing value in the TreeItem `value` property. items) Creates a ComboBox cell factory for use in `TreeView` controls.
public static < The type of the `TreeItem` elements contained within the TreeView. T> Callback<TreeView<T>, TreeCell<T>>	Returns: A `Callback` that will return a TreeCell that is able to work on the type of element contained within the TreeView. forTreeView(final ObservableList<T> An `ObservableList` containing zero or more items that will be shown to the user when the `ComboBox` menu is showing. These items must be of the same type as the TreeView generic type, such that upon selection, they replace the existing value in the `TreeItem` that is being edited (as noted in the `TreeView#editingItemProperty()`. items) Creates a ComboBox cell factory for use in `TreeView` controls.
public static < The type of the elements contained within the TreeView. T> Callback<TreeView<T>, TreeCell<T>>	Returns: A `Callback` that will return a TreeCell that is able to work on the type of element contained within the TreeView. forTreeView(final StringConverter<T> A `StringConverter` to convert the given item (of type T) to a String for displaying to the user. converter, final T... Zero or more items that will be shown to the user when the `ComboBox` menu is showing. These items must be of the same type as the TreeView<T>, such that upon selection, they replace the existing value in the TreeItem `value` property. items) Creates a ComboBox cell factory for use in `TreeView` controls.
public static < The type of the elements contained within the TreeView. T> Callback<TreeView<T>, TreeCell<T>>	Returns: A `Callback` that will return a TreeCell that is able to work on the type of element contained within the TreeView. forTreeView(final StringConverter<T> A `StringConverter` to convert the given item (of type T) to a String for displaying to the user. converter, final ObservableList<T> An `ObservableList` containing zero or more items that will be shown to the user when the `ComboBox` menu is showing. These items must be of the same type as the TreeView generic type, such that upon selection, they replace the existing value in the `TreeItem` that is being edited (as noted in the `TreeView#editingItemProperty()`. items) Creates a ComboBox cell factory for use in `TreeView` controls.
public final StringConverter<T>	Returns: the `StringConverter` used in this cell getConverter() Returns the `StringConverter` used in this cell.
public ObservableList<T>	Returns: the items to be displayed in this ComboBox when it is showing getItems() Returns the items to be displayed in the ComboBox when it is showing.
public final boolean	Returns: true if the ComboBox is editable isComboBoxEditable() Returns true if the ComboBox is editable.
public final void	setComboBoxEditable(boolean the editable value to be set for this ComboBox value) Configures the ComboBox to be editable (to allow user input outside of the options provide in the dropdown list).
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 item, boolean 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

comboBox	back to summary
private ComboBox<T> comboBox

comboBoxEditable	back to summary
private BooleanProperty comboBoxEditable

converter	back to summary
private ObjectProperty<StringConverter<T>> converter

hbox	back to summary
private HBox hbox Hides javafx.scene.control.cell.DefaultTreeCell.hbox.

items	back to summary
private final ObservableList<T> items

Constructor Detail

ComboBoxTreeCell	back to summary
public ComboBoxTreeCell() Creates a default ComboBoxTreeCell with an empty items list.

ComboBoxTreeCell back to summary

ComboBoxTreeCell	back to summary
public ComboBoxTreeCell(T... items) Creates a default `ComboBoxTreeCell` instance with the given items being used to populate the `ComboBox` when it is shown. Parameters items:T[] The items to show in the ComboBox popup menu when selected by the user. Annotations @SafeVarargs

public ComboBoxTreeCell(T... items)

Creates a default ComboBoxTreeCell instance with the given items being used to populate the ComboBox when it is shown.

Parameters

items:T[]: The items to show in the ComboBox popup menu when selected by the user.

Annotations

@SafeVarargs

ComboBoxTreeCell back to summary

ComboBoxTreeCell	back to summary
public ComboBoxTreeCell(StringConverter<T> converter, T... items) Creates a `ComboBoxTreeCell` instance with the given items being used to populate the `ComboBox` when it is shown, and the `StringConverter` being used to convert the item in to a user-readable form. Parameters converter:StringConverter<T> A `StringConverter` that can convert an item of type T into a user-readable string so that it may then be shown in the ComboBox popup menu. items:T[] The items to show in the ComboBox popup menu when selected by the user. Annotations @SafeVarargs

public ComboBoxTreeCell(StringConverter<T> converter, T... items)

Creates a ComboBoxTreeCell instance with the given items being used to populate the ComboBox when it is shown, and the StringConverter being used to convert the item in to a user-readable form.

Parameters

converter:StringConverter<T>: A StringConverter that can convert an item of type T into a user-readable string so that it may then be shown in the ComboBox popup menu.
items:T[]: The items to show in the ComboBox popup menu when selected by the user.

Annotations

@SafeVarargs

ComboBoxTreeCell back to summary

ComboBoxTreeCell	back to summary
public ComboBoxTreeCell(ObservableList<T> items) Creates a default `ComboBoxTreeCell` instance with the given items being used to populate the `ComboBox` when it is shown. Parameters items:ObservableList<T> The items to show in the ComboBox popup menu when selected by the user.

public ComboBoxTreeCell(ObservableList<T> items)

Creates a default ComboBoxTreeCell instance with the given items being used to populate the ComboBox when it is shown.

Parameters

items:ObservableList<T>: The items to show in the ComboBox popup menu when selected by the user.

ComboBoxTreeCell back to summary

ComboBoxTreeCell	back to summary
public ComboBoxTreeCell(StringConverter<T> converter, ObservableList<T> items) Creates a `ComboBoxTreeCell` instance with the given items being used to populate the `ComboBox` when it is shown, and the `StringConverter` being used to convert the item in to a user-readable form. Parameters converter:StringConverter<T> A `StringConverter` that can convert an item of type T into a user-readable string so that it may then be shown in the ComboBox popup menu. items:ObservableList<T> The items to show in the ComboBox popup menu when selected by the user.

public ComboBoxTreeCell(StringConverter<T> converter, ObservableList<T> items)

Creates a ComboBoxTreeCell instance with the given items being used to populate the ComboBox when it is shown, and the StringConverter being used to convert the item in to a user-readable form.

Parameters

converter:StringConverter<T>: A StringConverter that can convert an item of type T into a user-readable string so that it may then be shown in the ComboBox popup menu.
items:ObservableList<T>: The items to show in the ComboBox popup menu when selected by the user.

Method Detail

cancelEdit	back 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

cancelEdit

back 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

comboBoxEditableProperty	back to summary
public final BooleanProperty comboBoxEditableProperty() A property representing whether the ComboBox, when shown to the user, is editable or not. Returns:BooleanProperty the property representing whether the ComboBox, when shown to the user, is editable or not

comboBoxEditableProperty

back to summary

public final BooleanProperty comboBoxEditableProperty()

A property representing whether the ComboBox, when shown to the user, is editable or not.

Returns:BooleanProperty: the property representing whether the ComboBox, when shown to the user, is editable or not

converterProperty back to summary

converterProperty	back to summary
public final ObjectProperty<StringConverter<T>> converterProperty() The `StringConverter` property. Returns:ObjectProperty<StringConverter<T>> the `StringConverter` property

public final ObjectProperty<StringConverter<T>> converterProperty()

The StringConverter property.

Returns:ObjectProperty<StringConverter<T>>: the StringConverter property

forTreeView back to summary

forTreeView	back to summary
public static <T> Callback<TreeView<T>, TreeCell<T>> forTreeView(T... items) Creates a ComboBox cell factory for use in `TreeView` controls. By default, the ComboBoxCell is rendered as a `Label` when not being edited, and as a ComboBox when in editing mode. The ComboBox will, by default, stretch to fill the entire tree cell. Parameters <T> The type of the elements contained within the TreeView. items:T[] Zero or more items that will be shown to the user when the `ComboBox` menu is showing. These items must be of the same type as the TreeView<T>, such that upon selection, they replace the existing value in the TreeItem `value` property. Returns:Callback<TreeView<T>, TreeCell<T>> A `Callback` that will return a TreeCell that is able to work on the type of element contained within the TreeView. Annotations @SafeVarargs

public static <T> Callback<TreeView<T>, TreeCell<T>> forTreeView(T... items)

Creates a ComboBox cell factory for use in TreeView controls. By default, the ComboBoxCell is rendered as a Label when not being edited, and as a ComboBox when in editing mode. The ComboBox will, by default, stretch to fill the entire tree cell.

Parameters

<T>: The type of the elements contained within the TreeView.
items:T[]: Zero or more items that will be shown to the user when the ComboBox menu is showing. These items must be of the same type as the TreeView<T>, such that upon selection, they replace the existing value in the TreeItem value property.

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

A Callback that will return a TreeCell that is able to work on the type of element contained within the TreeView.

Annotations

@SafeVarargs

forTreeView back to summary

forTreeView	back to summary
public static <T> Callback<TreeView<T>, TreeCell<T>> forTreeView(final ObservableList<T> items) Creates a ComboBox cell factory for use in `TreeView` controls. By default, the ComboBoxCell is rendered as a `Label` when not being edited, and as a ComboBox when in editing mode. The ComboBox will, by default, stretch to fill the entire tree cell, excluding the space allocated to the tree cell indentation and disclosure node(i.e. the arrow). Parameters <T> The type of the `TreeItem` elements contained within the TreeView. items:ObservableList<T> An `ObservableList` containing zero or more items that will be shown to the user when the `ComboBox` menu is showing. These items must be of the same type as the TreeView generic type, such that upon selection, they replace the existing value in the `TreeItem` that is being edited (as noted in the `TreeView#editingItemProperty()`. Returns:Callback<TreeView<T>, TreeCell<T>> A `Callback` that will return a TreeCell that is able to work on the type of element contained within the TreeView.

public static <T> Callback<TreeView<T>, TreeCell<T>> forTreeView(final ObservableList<T> items)

Parameters

<T>: The type of the TreeItem elements contained within the TreeView.
items:ObservableList<T>: An ObservableList containing zero or more items that will be shown to the user when the ComboBox menu is showing. These items must be of the same type as the TreeView generic type, such that upon selection, they replace the existing value in the TreeItem that is being edited (as noted in the TreeView#editingItemProperty().

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

A Callback that will return a TreeCell that is able to work on the type of element contained within the TreeView.

forTreeView back to summary

forTreeView	back to summary
public static <T> Callback<TreeView<T>, TreeCell<T>> forTreeView(final StringConverter<T> converter, final T... items) Creates a ComboBox cell factory for use in `TreeView` controls. By default, the ComboBoxCell is rendered as a `Label` when not being edited, and as a ComboBox when in editing mode. The ComboBox will, by default, stretch to fill the entire tree cell. Parameters <T> The type of the elements contained within the TreeView. converter:StringConverter<T> A `StringConverter` to convert the given item (of type T) to a String for displaying to the user. items:T[] Zero or more items that will be shown to the user when the `ComboBox` menu is showing. These items must be of the same type as the TreeView<T>, such that upon selection, they replace the existing value in the TreeItem `value` property. Returns:Callback<TreeView<T>, TreeCell<T>> A `Callback` that will return a TreeCell that is able to work on the type of element contained within the TreeView. Annotations @SafeVarargs

public static <T> Callback<TreeView<T>, TreeCell<T>> forTreeView(final StringConverter<T> converter, final T... items)

Parameters

<T>: The type of the elements contained within the TreeView.
converter:StringConverter<T>: A StringConverter to convert the given item (of type T) to a String for displaying to the user.
items:T[]: Zero or more items that will be shown to the user when the ComboBox menu is showing. These items must be of the same type as the TreeView<T>, such that upon selection, they replace the existing value in the TreeItem value property.

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

A Callback that will return a TreeCell that is able to work on the type of element contained within the TreeView.

Annotations

@SafeVarargs

forTreeView back to summary

forTreeView	back to summary
public static <T> Callback<TreeView<T>, TreeCell<T>> forTreeView(final StringConverter<T> converter, final ObservableList<T> items) Creates a ComboBox cell factory for use in `TreeView` controls. By default, the ComboBoxCell is rendered as a `Label` when not being edited, and as a ComboBox when in editing mode. The ComboBox will, by default, stretch to fill the entire tree cell. Parameters <T> The type of the elements contained within the TreeView. converter:StringConverter<T> A `StringConverter` to convert the given item (of type T) to a String for displaying to the user. items:ObservableList<T> An `ObservableList` containing zero or more items that will be shown to the user when the `ComboBox` menu is showing. These items must be of the same type as the TreeView generic type, such that upon selection, they replace the existing value in the `TreeItem` that is being edited (as noted in the `TreeView#editingItemProperty()`. Returns:Callback<TreeView<T>, TreeCell<T>> A `Callback` that will return a TreeCell that is able to work on the type of element contained within the TreeView.

public static <T> Callback<TreeView<T>, TreeCell<T>> forTreeView(final StringConverter<T> converter, final ObservableList<T> items)

Parameters

<T>: The type of the elements contained within the TreeView.
converter:StringConverter<T>: A StringConverter to convert the given item (of type T) to a String for displaying to the user.
items:ObservableList<T>: An ObservableList containing zero or more items that will be shown to the user when the ComboBox menu is showing. These items must be of the same type as the TreeView generic type, such that upon selection, they replace the existing value in the TreeItem that is being edited (as noted in the TreeView#editingItemProperty().

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

A Callback that will return a TreeCell that is able to work on the type of element contained within the TreeView.

getConverter back to summary

getConverter	back to summary
public final StringConverter<T> getConverter() Returns the `StringConverter` used in this cell. Returns:StringConverter<T> the `StringConverter` used in this cell

public final StringConverter<T> getConverter()

Returns the StringConverter used in this cell.

Returns:StringConverter<T>: the StringConverter used in this cell

getItems	back to summary
public ObservableList<T> getItems() Returns the items to be displayed in the ComboBox when it is showing. Returns:ObservableList<T> the items to be displayed in this ComboBox when it is showing

getItems

back to summary

public ObservableList<T> getItems()

Returns the items to be displayed in the ComboBox when it is showing.

Returns:ObservableList<T>: the items to be displayed in this ComboBox when it is showing

isComboBoxEditable	back to summary
public final boolean isComboBoxEditable() Returns true if the ComboBox is editable. Returns:boolean true if the ComboBox is editable

isComboBoxEditable

back to summary

public final boolean isComboBoxEditable()

Returns true if the ComboBox is editable.

Returns:boolean: true if the ComboBox is editable

setComboBoxEditable	back to summary
public final void setComboBoxEditable(boolean value) Configures the ComboBox to be editable (to allow user input outside of the options provide in the dropdown list). Parameters value:boolean the editable value to be set for this ComboBox

setComboBoxEditable

back to summary

public final void setComboBoxEditable(boolean value)

Configures the ComboBox to be editable (to allow user input outside of the options provide in the dropdown list).

Parameters

value:boolean: the editable value to be set for this ComboBox

setConverter back to summary

setConverter	back 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

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

startEdit	back 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

startEdit

back 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

updateItem back to summary

updateItem	back 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: 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. 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

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:

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.
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

public Class ComboBoxTreeCell<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail