在 ComboBox 中为 FilteredList 设置谓词会影响输入
Setting predicate for FilteredList in ComboBox affects input
我实现了 ComboBox，其中它的列表由 ComboBox TextField 中的输入过滤。它的工作方式与您可能期望的此类控件的筛选器一样有效。列表中以输入文本开头的每个项目都显示在列表中。
我只有一个小问题。如果我 select 列表中的一个项目，然后尝试删除文本字段中的最后一个字符，则什么也不会发生。如果我 select 列表中的一个项目，然后尝试删除除最后一个字符之外的任何其他字符，则整个字符串都会被删除。只有当这是我在 ComboBox 中做的第一件事时，才会出现这两个问题。如果我先在组合框中写入内容，或者如果我第二次 select 一个项目，则会出现 none 所述的问题。
令我感到奇怪的是，这些问题似乎是由设置谓词引起的（如果我注释掉 setPredicate 的调用，一切正常）。这很奇怪，因为我认为这应该只会影响为其设置谓词的列表。它不应该影响 ComboBox.
的其余部分
import javafx.application.Application;
import javafx.beans.value.ChangeListener;
import javafx.beans.value.ObservableValue;
import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
import javafx.collections.transformation.FilteredList;
import javafx.scene.Scene;
import javafx.scene.control.ComboBox;
import javafx.scene.layout.VBox;
import javafx.stage.Stage;
import javafx.util.StringConverter;
public class TestInputFilter extends Application {
public void start(Stage stage) {
VBox root = new VBox();
ComboBox<ComboBoxItem> cb = new ComboBox<ComboBoxItem>();
cb.setEditable(true);
cb.setConverter(new StringConverter<ComboBoxItem>() {
@Override
// To convert the ComboBoxItem to a String we just call its
// toString() method.
public String toString(ComboBoxItem object) {
return object == null ? null : object.toString();
}
@Override
// To convert the String to a ComboBoxItem we loop through all of
// the items in the combobox dropdown and select anyone that starts
// with the String. If we don't find a match we create our own
// ComboBoxItem.
public ComboBoxItem fromString(String string) {
return cb.getItems().stream().filter(item -> item.getText().startsWith(string)).findFirst()
.orElse(new ComboBoxItem(string));
}
});
ObservableList<ComboBoxItem> options = FXCollections.observableArrayList(new ComboBoxItem("One is a number"),
new ComboBoxItem("Two is a number"), new ComboBoxItem("Three is a number"),
new ComboBoxItem("Four is a number"), new ComboBoxItem("Five is a number"),
new ComboBoxItem("Six is a number"), new ComboBoxItem("Seven is a number"));
FilteredList<ComboBoxItem> filteredOptions = new FilteredList<ComboBoxItem>(options, p -> true);
cb.setItems(filteredOptions);
InputFilter inputFilter = new InputFilter(cb, filteredOptions);
cb.getEditor().textProperty().addListener(inputFilter);
root.getChildren().add(cb);
stage.setScene(new Scene(root));
stage.show();
}
public static void main(String[] args) {
launch();
}
class ComboBoxItem {
private String text;
public ComboBoxItem(String text) {
this.text = text;
}
public String getText() {
return text;
}
@Override
public String toString() {
return text;
}
}
class InputFilter implements ChangeListener<String> {
private ComboBox<ComboBoxItem> box;
private FilteredList<ComboBoxItem> items;
public InputFilter(ComboBox<ComboBoxItem> box, FilteredList<ComboBoxItem> items) {
this.box = box;
this.items = items;
}
@Override
public void changed(ObservableValue<? extends String> observable, String oldValue, String newValue) {
String value = newValue;
// If any item is selected we get the first word of that item.
String selected = box.getSelectionModel().getSelectedItem() != null
? box.getSelectionModel().getSelectedItem().getText() : null;
// If an item is selected and the value of in the editor is the same
// as the selected item we don't filter the list.
if (selected != null && value.equals(selected)) {
items.setPredicate(item -> {
return true;
});
} else {
items.setPredicate(item -> {
if (item.getText().toUpperCase().startsWith(value.toUpperCase())) {
return true;
} else {
return false;
}
});
}
}
}
}
编辑：我试图重写关键监听器以解决问题：
cb.getEditor().addEventFilter(KeyEvent.KEY_PRESSED, e -> {
TextField editor = cb.getEditor();
int caretPos = cb.getEditor().getCaretPosition();
StringBuilder text = new StringBuilder(cb.getEditor().getText());
// If BACKSPACE is pressed we remove the character at the index
// before the caret position.
if (e.getCode().equals(KeyCode.BACK_SPACE)) {
// BACKSPACE should only remove a character if the caret
// position isn't zero.
if (caretPos > 0) {
text.deleteCharAt(--caretPos);
}
e.consume();
}
// If DELETE is pressed we remove the character at the caret
// position.
else if (e.getCode().equals(KeyCode.DELETE)) {
// DELETE should only remove a character if the caret isn't
// positioned after that last character in the text.
if (caretPos < text.length()) {
text.deleteCharAt(caretPos);
}
}
// If LEFT key is pressed we move the caret one step to the left.
else if (e.getCode().equals(KeyCode.LEFT)) {
caretPos--;
}
// If RIGHT key is pressed we move the caret one step to the right.
else if (e.getCode().equals(KeyCode.RIGHT)) {
caretPos++;
}
// Otherwise we just add the key text to the text.
// TODO We are currently not handling UP/DOWN keys (should move
// caret to the end/beginning of the text).
// TODO We are currently not handling keys that doesn't represent
// any symbol, like ALT. Since they don't have a text, they will
// just move the caret one step to the right. In this case, that
// caret should just hold its current position.
else {
text.insert(caretPos++, e.getText());
e.consume();
}
final int finalPos = caretPos;
// We set the editor text to the new text and finally we move the
// caret to its new position.
editor.setText(text.toString());
Platform.runLater(() -> editor.positionCaret(finalPos));
});
// We just consume KEY_RELEASED and KEY_TYPED since we don't want to
// have duplicated input.
cb.getEditor().addEventFilter(KeyEvent.KEY_RELEASED, e -> {
e.consume();
});
cb.getEditor().addEventFilter(KeyEvent.KEY_TYPED, e -> {
e.consume();
});
遗憾的是，这也不能解决问题。如果我例如选择 "Three is a number" 项，然后尝试删除 "Three" 中的最后一个 "e"，这是文本 属性 将切换的值：
TextProperty: Three is a number
TextPropery: Thre is a number
TextPropery:
所以它首先删除了正确的字符，但随后由于某种原因删除了整个 String。如前所述，这仅是因为谓词已设置，并且仅当我第一次 select 编辑了一个项目后进行第一次输入时才会发生。
设置谓词将触发您的 ChangeListener，因为您正在更改 ComboBox-Items，因此更改了 cb-editor 的文本值。删除侦听器并重新添加它将防止那些意外的操作。
我在您的更改中添加了三行(...) - 方法。
尝试一下，如果这能解决您的问题。
信息：我只用了你的第一段代码
@Override
public void changed(ObservableValue<? extends String> observable, String oldValue, String newValue) {
String value = newValue;
// If any item is selected we get the first word of that item.
String selected = box.getSelectionModel().getSelectedItem() != null
? box.getSelectionModel().getSelectedItem().getText() : null;
box.getEditor().textProperty().removeListener(this); // new line #1
// If an item is selected and the value of in the editor is the same
// as the selected item we don't filter the list.
if (selected != null && value.equals(selected)) {
items.setPredicate(item -> {
return true;
});
} else {
items.setPredicate(item -> {
if (item.getText().toUpperCase().startsWith(value.toUpperCase())) {
return true;
} else {
return false;
}
});
box.getEditor().setText(newValue); // new line #2
}
box.getEditor().textProperty().addListener(this); // new line #3
}
乔纳坦，
正如 Manuel 所说，一个问题是 setPredicate() 将触发您的 changed() 方法两次，因为您正在更改组合框模型，但真正的问题是组合框将用任何看起来合适的值覆盖编辑器值。以下是对您的症状的解释：
If I select an item from the list, and then try to remove the last
character in the textfield, nothing happens.
在这种情况下，最后一个字符的删除实际上发生了，但是对 setPredicate() 的第一次调用匹配了一个可能的项目（与您删除的最后一个字符完全相同的项目）并将组合框内容更改为仅一项。这会导致调用，其中组合框使用当前 combobox.getValue() 字符串恢复编辑器值，给人一种没有任何反应的错觉。它还会导致第二次调用您的 changed() 方法，但此时编辑器文本已经更改。
Why do this only happen the first time, but then never again?
好问题！这只会发生一次，因为您正在修改组合框的整个底层模型一次（如前所述，这会触发对 changed() 方法的第二次调用）。
所以在上一个场景发生后，如果你点击下拉按钮（向右箭头），你会看到你只剩下一个项目，如果你再次尝试删除一个字符，你仍然会留下相同的项目，即是，模型（组合框的内容）没有改变，因为 setPredicate() 仍将匹配相同的内容，因此不会导致 TextInputControl class 中的 markInvalid() 调用，因为内容实际上没有更改，这意味着不再恢复项目字符串（如果您想查看第一次实际恢复文本字段的位置，请参阅带有 JavaFX 源的 ComboBoxPopupControl.updateDisplayNode() 方法）。
If I select an item from the list, and then try to remove any other
character than the last, the whole string gets removed.
在你的第二个场景中，没有任何东西匹配第一个 setPredicate() 调用（没有项目匹配你的 startsWith 条件），它删除了组合框中的所有项目，也删除了你当前的选择和编辑器字符串。
提示：尝试自己理解这一点，在 changed() 方法中切换一个断点以查看它进入了多少次以及为什么（如果您想关注 ComboBox 及其组件，则需要 JavaFX 源代码行为）
解法：
如果您想继续使用您的 ChangeListener，您可以通过在过滤后恢复编辑器中的文本来简单地解决您的主要问题（即在 setPredicate 调用之后编辑器内容被替换）：
class InputFilter implements ChangeListener<String> {
private ComboBox<ComboBoxItem> box;
private FilteredList<ComboBoxItem> items;
public InputFilter(ComboBox<ComboBoxItem> box, FilteredList<ComboBoxItem> items) {
this.box = box;
this.items = items;
}
@Override
public void changed(ObservableValue<? extends String> observable, String oldValue, String newValue) {
String value = newValue;
// If any item is selected we get the first word of that item.
String selected = box.getSelectionModel().getSelectedItem() != null
? box.getSelectionModel().getSelectedItem().getText() : null;
// If an item is selected and the value of in the editor is the same
// as the selected item we don't filter the list.
if (selected != null && value.equals(selected)) {
items.setPredicate(item -> {
return true;
});
} else {
// This will most likely change the box editor contents
items.setPredicate(item -> {
if (item.getText().toUpperCase().startsWith(value.toUpperCase())) {
return true;
} else {
return false;
}
});
// Restore the original search text since it was changed
box.getEditor().setText(value);
}
//box.show(); // <-- Uncomment this line for a neat look
}
}
就个人而言，我过去曾使用 KeyEvent 处理程序完成过此操作（以避免在 changed() 事件中多次调用我的代码），但是您始终可以使用信号量或您最喜欢的 class java.util.concurrent class 以避免任何不必要的重新进入你的方法，如果你觉得你开始需要它。现在，getEditor().setText() 将始终尾部恢复正确的值，即使相同的方法冒泡两次或三次也是如此。
希望对您有所帮助！
我实现了 ComboBox，其中它的列表由 ComboBox TextField 中的输入过滤。它的工作方式与您可能期望的此类控件的筛选器一样有效。列表中以输入文本开头的每个项目都显示在列表中。
我只有一个小问题。如果我 select 列表中的一个项目，然后尝试删除文本字段中的最后一个字符，则什么也不会发生。如果我 select 列表中的一个项目，然后尝试删除除最后一个字符之外的任何其他字符，则整个字符串都会被删除。只有当这是我在 ComboBox 中做的第一件事时，才会出现这两个问题。如果我先在组合框中写入内容，或者如果我第二次 select 一个项目，则会出现 none 所述的问题。
令我感到奇怪的是，这些问题似乎是由设置谓词引起的（如果我注释掉 setPredicate 的调用，一切正常）。这很奇怪，因为我认为这应该只会影响为其设置谓词的列表。它不应该影响 ComboBox.
import javafx.application.Application;
import javafx.beans.value.ChangeListener;
import javafx.beans.value.ObservableValue;
import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
import javafx.collections.transformation.FilteredList;
import javafx.scene.Scene;
import javafx.scene.control.ComboBox;
import javafx.scene.layout.VBox;
import javafx.stage.Stage;
import javafx.util.StringConverter;
public class TestInputFilter extends Application {
public void start(Stage stage) {
VBox root = new VBox();
ComboBox<ComboBoxItem> cb = new ComboBox<ComboBoxItem>();
cb.setEditable(true);
cb.setConverter(new StringConverter<ComboBoxItem>() {
@Override
// To convert the ComboBoxItem to a String we just call its
// toString() method.
public String toString(ComboBoxItem object) {
return object == null ? null : object.toString();
}
@Override
// To convert the String to a ComboBoxItem we loop through all of
// the items in the combobox dropdown and select anyone that starts
// with the String. If we don't find a match we create our own
// ComboBoxItem.
public ComboBoxItem fromString(String string) {
return cb.getItems().stream().filter(item -> item.getText().startsWith(string)).findFirst()
.orElse(new ComboBoxItem(string));
}
});
ObservableList<ComboBoxItem> options = FXCollections.observableArrayList(new ComboBoxItem("One is a number"),
new ComboBoxItem("Two is a number"), new ComboBoxItem("Three is a number"),
new ComboBoxItem("Four is a number"), new ComboBoxItem("Five is a number"),
new ComboBoxItem("Six is a number"), new ComboBoxItem("Seven is a number"));
FilteredList<ComboBoxItem> filteredOptions = new FilteredList<ComboBoxItem>(options, p -> true);
cb.setItems(filteredOptions);
InputFilter inputFilter = new InputFilter(cb, filteredOptions);
cb.getEditor().textProperty().addListener(inputFilter);
root.getChildren().add(cb);
stage.setScene(new Scene(root));
stage.show();
}
public static void main(String[] args) {
launch();
}
class ComboBoxItem {
private String text;
public ComboBoxItem(String text) {
this.text = text;
}
public String getText() {
return text;
}
@Override
public String toString() {
return text;
}
}
class InputFilter implements ChangeListener<String> {
private ComboBox<ComboBoxItem> box;
private FilteredList<ComboBoxItem> items;
public InputFilter(ComboBox<ComboBoxItem> box, FilteredList<ComboBoxItem> items) {
this.box = box;
this.items = items;
}
@Override
public void changed(ObservableValue<? extends String> observable, String oldValue, String newValue) {
String value = newValue;
// If any item is selected we get the first word of that item.
String selected = box.getSelectionModel().getSelectedItem() != null
? box.getSelectionModel().getSelectedItem().getText() : null;
// If an item is selected and the value of in the editor is the same
// as the selected item we don't filter the list.
if (selected != null && value.equals(selected)) {
items.setPredicate(item -> {
return true;
});
} else {
items.setPredicate(item -> {
if (item.getText().toUpperCase().startsWith(value.toUpperCase())) {
return true;
} else {
return false;
}
});
}
}
}
}
编辑：我试图重写关键监听器以解决问题：
cb.getEditor().addEventFilter(KeyEvent.KEY_PRESSED, e -> {
TextField editor = cb.getEditor();
int caretPos = cb.getEditor().getCaretPosition();
StringBuilder text = new StringBuilder(cb.getEditor().getText());
// If BACKSPACE is pressed we remove the character at the index
// before the caret position.
if (e.getCode().equals(KeyCode.BACK_SPACE)) {
// BACKSPACE should only remove a character if the caret
// position isn't zero.
if (caretPos > 0) {
text.deleteCharAt(--caretPos);
}
e.consume();
}
// If DELETE is pressed we remove the character at the caret
// position.
else if (e.getCode().equals(KeyCode.DELETE)) {
// DELETE should only remove a character if the caret isn't
// positioned after that last character in the text.
if (caretPos < text.length()) {
text.deleteCharAt(caretPos);
}
}
// If LEFT key is pressed we move the caret one step to the left.
else if (e.getCode().equals(KeyCode.LEFT)) {
caretPos--;
}
// If RIGHT key is pressed we move the caret one step to the right.
else if (e.getCode().equals(KeyCode.RIGHT)) {
caretPos++;
}
// Otherwise we just add the key text to the text.
// TODO We are currently not handling UP/DOWN keys (should move
// caret to the end/beginning of the text).
// TODO We are currently not handling keys that doesn't represent
// any symbol, like ALT. Since they don't have a text, they will
// just move the caret one step to the right. In this case, that
// caret should just hold its current position.
else {
text.insert(caretPos++, e.getText());
e.consume();
}
final int finalPos = caretPos;
// We set the editor text to the new text and finally we move the
// caret to its new position.
editor.setText(text.toString());
Platform.runLater(() -> editor.positionCaret(finalPos));
});
// We just consume KEY_RELEASED and KEY_TYPED since we don't want to
// have duplicated input.
cb.getEditor().addEventFilter(KeyEvent.KEY_RELEASED, e -> {
e.consume();
});
cb.getEditor().addEventFilter(KeyEvent.KEY_TYPED, e -> {
e.consume();
});
遗憾的是，这也不能解决问题。如果我例如选择 "Three is a number" 项，然后尝试删除 "Three" 中的最后一个 "e"，这是文本 属性 将切换的值：
TextProperty: Three is a number
TextPropery: Thre is a number
TextPropery:
所以它首先删除了正确的字符，但随后由于某种原因删除了整个 String。如前所述，这仅是因为谓词已设置，并且仅当我第一次 select 编辑了一个项目后进行第一次输入时才会发生。
设置谓词将触发您的 ChangeListener，因为您正在更改 ComboBox-Items，因此更改了 cb-editor 的文本值。删除侦听器并重新添加它将防止那些意外的操作。
我在您的更改中添加了三行(...) - 方法。 尝试一下，如果这能解决您的问题。
信息：我只用了你的第一段代码
@Override
public void changed(ObservableValue<? extends String> observable, String oldValue, String newValue) {
String value = newValue;
// If any item is selected we get the first word of that item.
String selected = box.getSelectionModel().getSelectedItem() != null
? box.getSelectionModel().getSelectedItem().getText() : null;
box.getEditor().textProperty().removeListener(this); // new line #1
// If an item is selected and the value of in the editor is the same
// as the selected item we don't filter the list.
if (selected != null && value.equals(selected)) {
items.setPredicate(item -> {
return true;
});
} else {
items.setPredicate(item -> {
if (item.getText().toUpperCase().startsWith(value.toUpperCase())) {
return true;
} else {
return false;
}
});
box.getEditor().setText(newValue); // new line #2
}
box.getEditor().textProperty().addListener(this); // new line #3
}
乔纳坦，
正如 Manuel 所说，一个问题是 setPredicate() 将触发您的 changed() 方法两次，因为您正在更改组合框模型，但真正的问题是组合框将用任何看起来合适的值覆盖编辑器值。以下是对您的症状的解释：
If I select an item from the list, and then try to remove the last character in the textfield, nothing happens.
在这种情况下，最后一个字符的删除实际上发生了，但是对 setPredicate() 的第一次调用匹配了一个可能的项目（与您删除的最后一个字符完全相同的项目）并将组合框内容更改为仅一项。这会导致调用，其中组合框使用当前 combobox.getValue() 字符串恢复编辑器值，给人一种没有任何反应的错觉。它还会导致第二次调用您的 changed() 方法，但此时编辑器文本已经更改。
Why do this only happen the first time, but then never again?
好问题！这只会发生一次，因为您正在修改组合框的整个底层模型一次（如前所述，这会触发对 changed() 方法的第二次调用）。
所以在上一个场景发生后，如果你点击下拉按钮（向右箭头），你会看到你只剩下一个项目，如果你再次尝试删除一个字符，你仍然会留下相同的项目，即是，模型（组合框的内容）没有改变，因为 setPredicate() 仍将匹配相同的内容，因此不会导致 TextInputControl class 中的 markInvalid() 调用，因为内容实际上没有更改，这意味着不再恢复项目字符串（如果您想查看第一次实际恢复文本字段的位置，请参阅带有 JavaFX 源的 ComboBoxPopupControl.updateDisplayNode() 方法）。
If I select an item from the list, and then try to remove any other character than the last, the whole string gets removed.
在你的第二个场景中，没有任何东西匹配第一个 setPredicate() 调用（没有项目匹配你的 startsWith 条件），它删除了组合框中的所有项目，也删除了你当前的选择和编辑器字符串。
提示：尝试自己理解这一点，在 changed() 方法中切换一个断点以查看它进入了多少次以及为什么（如果您想关注 ComboBox 及其组件，则需要 JavaFX 源代码行为）
解法： 如果您想继续使用您的 ChangeListener，您可以通过在过滤后恢复编辑器中的文本来简单地解决您的主要问题（即在 setPredicate 调用之后编辑器内容被替换）：
class InputFilter implements ChangeListener<String> {
private ComboBox<ComboBoxItem> box;
private FilteredList<ComboBoxItem> items;
public InputFilter(ComboBox<ComboBoxItem> box, FilteredList<ComboBoxItem> items) {
this.box = box;
this.items = items;
}
@Override
public void changed(ObservableValue<? extends String> observable, String oldValue, String newValue) {
String value = newValue;
// If any item is selected we get the first word of that item.
String selected = box.getSelectionModel().getSelectedItem() != null
? box.getSelectionModel().getSelectedItem().getText() : null;
// If an item is selected and the value of in the editor is the same
// as the selected item we don't filter the list.
if (selected != null && value.equals(selected)) {
items.setPredicate(item -> {
return true;
});
} else {
// This will most likely change the box editor contents
items.setPredicate(item -> {
if (item.getText().toUpperCase().startsWith(value.toUpperCase())) {
return true;
} else {
return false;
}
});
// Restore the original search text since it was changed
box.getEditor().setText(value);
}
//box.show(); // <-- Uncomment this line for a neat look
}
}
就个人而言，我过去曾使用 KeyEvent 处理程序完成过此操作（以避免在 changed() 事件中多次调用我的代码），但是您始终可以使用信号量或您最喜欢的 class java.util.concurrent class 以避免任何不必要的重新进入你的方法，如果你觉得你开始需要它。现在，getEditor().setText() 将始终尾部恢复正确的值，即使相同的方法冒泡两次或三次也是如此。
希望对您有所帮助！