ChoiceBox does not appear to correctly handle changes to the underlying items list which return true for Change.wasUpdated().

To reproduce, run the following test code which displays a ChoiceBox and TextField. The ChoiceBox is backed by an ObservableList with an extractor installed, so changes to the nameProperty of the Items in the list will fire update events on the list.

Select an item in the ChoiceBox, then type a new value in the text field and hit Enter. The selected value will correctly update, but the ChoiceBox's popup will now display too many values. Selecting values beyond the changed value in the list will display unpredictable selected values.


import java.util.stream.Collectors;
import java.util.stream.IntStream;

import javafx.application.Application;
import javafx.beans.Observable;
import javafx.beans.binding.Bindings;
import javafx.beans.property.SimpleStringProperty;
import javafx.beans.property.StringProperty;
import javafx.collections.FXCollections;
import javafx.collections.ListChangeListener.Change;
import javafx.collections.ObservableList;
import javafx.scene.Scene;
import javafx.scene.control.ChoiceBox;
import javafx.scene.control.TextField;
import javafx.scene.layout.BorderPane;
import javafx.stage.Stage;

public class ChoiceBoxUpdateExample extends Application {

@Override
public void start(Stage primaryStage) {
        ChoiceBox<Item> choiceBox = new ChoiceBox<>();
ObservableList<Item> items = FXCollections.observableArrayList(
item -> new Observable[] {item.nameProperty()}); // the extractor
items.addAll(
IntStream.rangeClosed(1, 10)
.mapToObj(i -> new Item("Item "+i))
.collect(Collectors.toList()));
choiceBox.setItems(items);

// To help debugging...
items.addListener((Change<? extends Item> change) -> {
while (change.next()) {
if (change.wasAdded()) {
System.out.println("Added");
}
if (change.wasPermutated()) {
System.out.println("Permutated");
}
if (change.wasReplaced()) {
System.out.println("Replaced");
}
if (change.wasRemoved()) {
System.out.println("Removed");
}
if (change.wasUpdated()) {
System.out.println("Updated");
}
System.out.println("From "+change.getFrom()+" To: "+change.getTo());
}
});

TextField changeSelectedField = new TextField();
changeSelectedField.disableProperty()
.bind(Bindings.isNull(choiceBox.getSelectionModel().selectedItemProperty()));
changeSelectedField.setOnAction(event ->
choiceBox.getSelectionModel().getSelectedItem().setName(changeSelectedField.getText()));

BorderPane root = new BorderPane();
root.setTop(choiceBox);
root.setBottom(changeSelectedField);
Scene scene = new Scene(root, 250, 150);
primaryStage.setScene(scene);
primaryStage.show();
}

public static class Item {
public final StringProperty name = new SimpleStringProperty();
public StringProperty nameProperty() {
return name ;
}
public final String getName() {
return nameProperty().get();
}
public final void setName(String name) {
nameProperty().set(name);
}
public Item(String name) {
setName(name);
}
@Override
public String toString() {
return getName();
}
}

public static void main(String[] args) {
launch(args);
}
}

See http://stackoverflow.com/questions/25437684/javafx-choiceox-change-not-updating-graphics/25438307#25438307