在组合框中设置“筛选列表”的谓词会影响输入



我实现了ComboBox,其中其列表按ComboBox TextField中的输入进行过滤。它的工作方式与您可能期望此类控件的筛选器工作一样。列表中以输入文本开头的每个项目都显示在列表中。

我只有一个小问题。如果我从列表中选择一个项目,然后尝试删除文本字段中的最后一个字符,则没有任何反应。如果我从列表中选择一个项目,然后尝试删除除最后一个字符以外的任何其他字符,则整个字符串将被删除。只有当这是我在ComboBox中做的第一件事时,才会出现这两个问题。如果我先在组合框中写一些东西,或者第二次选择一个项目,则不会发生所描述的问题。

对我来说真正奇怪的是,这些问题似乎是由设置的谓词引起的(如果我注释掉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();
});

可悲的是,这也不能解决问题。例如,如果我选择"三是一个数字"项,然后尝试删除"三"中的最后一个"e",这是文本属性将在以下值之间切换的值:

TextProperty: Three is a number
TextPropery: Thre is a number
TextPropery: 

因此,它首先删除了正确的字符,但随后由于某种原因删除了整个String。如前所述,发生这种情况只是因为已设置谓词,并且仅在我第一次选择项目后进行第一次输入时才会发生。

Jonatan,

正如 Manuel 所说,一个问题是 setPredicate(( 将触发您的 changed(( 方法两次,因为您正在更改组合框模型,但是真正的问题是组合框会用任何看起来合适的值覆盖编辑器值。以下是对您的症状的解释:

如果我从列表中选择一个项目,然后尝试删除最后一个项目 字符,则没有任何反应。

在这种情况下,删除最后一个字符实际上正在发生,但是对 setPredicate(( 的第一次调用匹配一个可能的项目(与您删除最后一个字符的项目完全相同(,并将组合框内容更改为仅一个项目。这会导致一个调用,其中组合框使用当前的 combobox.getValue(( 字符串恢复编辑器值,从而产生什么都没有发生的错觉。它还会导致对 changed(( 方法的第二次调用,但此时编辑器文本已经更改。

为什么这种情况只发生第一次,但后来再也不会发生?

问得好!这只发生一次,因为你修改了一次组合框的整个底层模型(如前所述,这会触发对 changed(( 方法的第二次调用(。

因此,在上一个场景发生后,如果您单击下拉按钮(向右箭头(,您将看到您只剩下一个项目,如果您再次尝试删除一个字符,您仍然会剩下相同的项目,也就是说,模型(组合框的内容(没有改变,因为 setPredicate(( 仍将匹配相同的内容, 因此不会在 TextInputControl 类中引起 markInvalid(( 调用,因为内容实际上并没有改变,这意味着不会再次恢复项目字符串(如果您想查看第一次实际恢复文本字段的位置,请参阅 ComboBoxPopupControl.updateDisplayNode(( 方法与 JavaFX 源(。

如果我从列表中选择一个项目,然后尝试删除任何其他项目 字符比最后一个字符,整个字符串被删除。

在第二种情况下,没有任何内容与第一个 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处理程序做过此操作(以避免在change((事件中多次调用我的代码(,但是如果您觉得开始需要它,您可以随时使用信号量或java.util.concurrent 类中您喜欢的类来避免任何不必要的重新进入您的方法。现在,getEditor((.setText(( 将始终尾部恢复正确的值,即使相同的方法冒泡两到三次。

希望这有帮助!

设置谓词将触发您的 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
}

最新更新