Top Description Fields Constructors Methods
com.dlsc.gemsfx

public Class RemovableListCell<T>

extends ListCell<T>
Class Inheritance
Type Parameters
<T>
the type of the list cell item
Imports
javafx.beans.property.ObjectProperty, .SimpleObjectProperty, javafx.geometry.Pos, javafx.scene.control.Label, .ListCell, .ListView, javafx.scene.input.MouseEvent, javafx.scene.layout.HBox, .StackPane, org.kordamp.ikonli.javafx.FontIcon, org.kordamp.ikonli.materialdesign.MaterialDesign, java.util.function.BiConsumer
A list cell that displays a remove button on the right side. The remove button is only visible when the mouse hovers over the cell. When the remove button is clicked, the onRemove callback is invoked.

Field Summary

Modifier and TypeField and Description
private final HBox
containerBox

private final Label
label

private ObjectProperty<BiConsumer<ListView<T>, T>>
onRemove

Constructor Summary

AccessConstructor and Description
public
RemovableListCell()

Constructs a new cell.

public
RemovableListCell(BiConsumer<ListView<T>, T> onRemove)

Constructs a new cell with the given remove handler function.

Method Summary

Modifier and TypeMethod and Description
public final BiConsumer<ListView<T>, T>
getOnRemove()

public final ObjectProperty<BiConsumer<ListView<T>, T>>

Returns:

the onRemoveProperty
onRemoveProperty()

A callback that is invoked when the remove button is clicked.

private void
removeItem(MouseEvent event)

public final void
setOnRemove(BiConsumer<ListView<T>, T> onRemove)

protected 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.ListCell:
cancelEditcommitEditcreateDefaultSkinexecuteAccessibleActiongetListViewlayoutChildrenlistViewPropertyqueryAccessibleAttributestartEditupdateListView

Field Detail

containerBoxback to summary
private final HBox containerBox
labelback to summary
private final Label label
onRemoveback to summary
private ObjectProperty<BiConsumer<ListView<T>, T>> onRemove

Constructor Detail

RemovableListCellback to summary
public RemovableListCell()

Constructs a new cell. Applications need to call setOnRemove(BiConsumer) to define a function that will remove the item shown by the cell.

RemovableListCellback to summary
public RemovableListCell(BiConsumer<ListView<T>, T> onRemove)

Constructs a new cell with the given remove handler function.

Method Detail

getOnRemoveback to summary
public final BiConsumer<ListView<T>, T> getOnRemove()
onRemovePropertyback to summary
public final ObjectProperty<BiConsumer<ListView<T>, T>> onRemoveProperty()

A callback that is invoked when the remove button is clicked.

Returns:ObjectProperty<BiConsumer<ListView<T>, T>>

the onRemoveProperty

removeItemback to summary
private void removeItem(MouseEvent event)
setOnRemoveback to summary
public final void setOnRemove(BiConsumer<ListView<T>, T> onRemove)
updateItemback to summary
protected 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