|
| 1 | +package org.jabref.gui.commonfxcontrols; |
| 2 | + |
| 3 | +import java.util.ArrayList; |
| 4 | +import java.util.List; |
| 5 | +import java.util.Map; |
| 6 | +import java.util.stream.Collectors; |
| 7 | + |
| 8 | +import javafx.scene.control.ContextMenu; |
| 9 | +import javafx.scene.control.CustomMenuItem; |
| 10 | +import javafx.scene.control.Label; |
| 11 | +import javafx.scene.control.Menu; |
| 12 | +import javafx.scene.control.MenuItem; |
| 13 | +import javafx.scene.control.TextField; |
| 14 | +import javafx.scene.control.cell.TextFieldTableCell; |
| 15 | + |
| 16 | +import org.jabref.logic.citationkeypattern.CitationKeyPattern; |
| 17 | +import org.jabref.logic.l10n.Localization; |
| 18 | + |
| 19 | +public class CitationKeyPatternSuggestionCell extends TextFieldTableCell<CitationKeyPatternsPanelItemModel, String> { |
| 20 | + private final CitationKeyPatternSuggestionTextField searchField; |
| 21 | + |
| 22 | + public CitationKeyPatternSuggestionCell(List<String> citationKeyPatterns) { |
| 23 | + this.searchField = new CitationKeyPatternSuggestionTextField(citationKeyPatterns); |
| 24 | + searchField.setOnAction(event -> commitEdit(searchField.getText())); |
| 25 | + } |
| 26 | + |
| 27 | + @Override |
| 28 | + public void startEdit() { |
| 29 | + super.startEdit(); |
| 30 | + searchField.setText(getItem()); |
| 31 | + setGraphic(searchField); |
| 32 | + searchField.requestFocus(); |
| 33 | + } |
| 34 | + |
| 35 | + @Override |
| 36 | + public void cancelEdit() { |
| 37 | + super.cancelEdit(); |
| 38 | + setGraphic(null); |
| 39 | + } |
| 40 | + |
| 41 | + @Override |
| 42 | + public void commitEdit(String newValue) { |
| 43 | + super.commitEdit(newValue); |
| 44 | + getTableView().getItems().get(getIndex()).setPattern(newValue); |
| 45 | + setGraphic(null); |
| 46 | + } |
| 47 | + |
| 48 | + @Override |
| 49 | + public void updateItem(String item, boolean empty) { |
| 50 | + super.updateItem(item, empty); |
| 51 | + if (empty || item == null) { |
| 52 | + setGraphic(null); |
| 53 | + setText(null); |
| 54 | + } else { |
| 55 | + setText(item); |
| 56 | + } |
| 57 | + } |
| 58 | + |
| 59 | + static class CitationKeyPatternSuggestionTextField extends TextField { |
| 60 | + // Maximum number of entries that can be displayed in the popup menu. |
| 61 | + private static final int MAX_ENTRIES = 7; |
| 62 | + |
| 63 | + private final List<String> citationKeyPatterns; |
| 64 | + private final ContextMenu suggestionsList; |
| 65 | + |
| 66 | + public CitationKeyPatternSuggestionTextField(List<String> citationKeyPatterns) { |
| 67 | + this.citationKeyPatterns = new ArrayList<>(citationKeyPatterns); |
| 68 | + this.suggestionsList = new ContextMenu(); |
| 69 | + |
| 70 | + setListener(); |
| 71 | + } |
| 72 | + |
| 73 | + private void setListener() { |
| 74 | + textProperty().addListener((observable, oldValue, newValue) -> { |
| 75 | + String enteredText = getText(); |
| 76 | + if (enteredText == null || enteredText.isEmpty()) { |
| 77 | + suggestionsList.hide(); |
| 78 | + } else { |
| 79 | + List<String> filteredEntries = citationKeyPatterns.stream() |
| 80 | + .filter(e -> e.toLowerCase().contains(enteredText.toLowerCase())) |
| 81 | + .collect(Collectors.toList()); |
| 82 | + |
| 83 | + if (!filteredEntries.isEmpty()) { |
| 84 | + populatePopup(filteredEntries); |
| 85 | + if (!suggestionsList.isShowing() && getScene() != null) { |
| 86 | + double screenX = localToScreen(0, 0).getX(); |
| 87 | + double screenY = localToScreen(0, 0).getY() + getHeight(); |
| 88 | + suggestionsList.show(this, screenX, screenY); |
| 89 | + } |
| 90 | + } else { |
| 91 | + suggestionsList.hide(); |
| 92 | + } |
| 93 | + } |
| 94 | + }); |
| 95 | + |
| 96 | + focusedProperty().addListener((observable, oldValue, newValue) -> { |
| 97 | + suggestionsList.hide(); |
| 98 | + }); |
| 99 | + } |
| 100 | + |
| 101 | + private void populatePopup(List<String> searchResult) { |
| 102 | + List<CustomMenuItem> menuItems = new ArrayList<>(); |
| 103 | + int count = Math.min(searchResult.size(), MAX_ENTRIES); |
| 104 | + |
| 105 | + for (int i = 0; i < count; i++) { |
| 106 | + final String result = searchResult.get(i); |
| 107 | + Label entryLabel = new Label(result); |
| 108 | + entryLabel.setPrefWidth(getWidth()); |
| 109 | + |
| 110 | + CustomMenuItem item = new CustomMenuItem(entryLabel, true); |
| 111 | + item.setHideOnClick(false); |
| 112 | + |
| 113 | + menuItems.add(item); |
| 114 | + |
| 115 | + item.setOnAction(actionEvent -> { |
| 116 | + setText(result); |
| 117 | + positionCaret(result.length()); |
| 118 | + suggestionsList.hide(); |
| 119 | + }); |
| 120 | + } |
| 121 | + |
| 122 | + suggestionsList.getItems().clear(); |
| 123 | + suggestionsList.getItems().add(createPatternsSubMenu()); |
| 124 | + suggestionsList.getItems().addAll(menuItems); |
| 125 | + |
| 126 | + if (!menuItems.isEmpty()) { |
| 127 | + menuItems.getFirst().getContent().requestFocus(); |
| 128 | + } |
| 129 | + } |
| 130 | + |
| 131 | + private Menu createPatternsSubMenu() { |
| 132 | + Menu patternsSubMenu = new Menu(Localization.lang("All patterns")); |
| 133 | + |
| 134 | + Map<CitationKeyPattern.Category, List<CitationKeyPattern>> categorizedPatterns = |
| 135 | + CitationKeyPattern.getAllPatterns().stream() |
| 136 | + .collect(Collectors.groupingBy(CitationKeyPattern::getCategory)); |
| 137 | + |
| 138 | + Map<CitationKeyPattern.Category, String> categoryNames = Map.of( |
| 139 | + CitationKeyPattern.Category.AUTHOR_RELATED, Localization.lang("Author related"), |
| 140 | + CitationKeyPattern.Category.EDITOR_RELATED, Localization.lang("Editor related"), |
| 141 | + CitationKeyPattern.Category.TITLE_RELATED, Localization.lang("Title related"), |
| 142 | + CitationKeyPattern.Category.OTHER_FIELDS, Localization.lang("Other fields"), |
| 143 | + CitationKeyPattern.Category.BIBENTRY_FIELDS, Localization.lang("BibEntry fields") |
| 144 | + ); |
| 145 | + |
| 146 | + for (Map.Entry<CitationKeyPattern.Category, String> entry : categoryNames.entrySet()) { |
| 147 | + CitationKeyPattern.Category category = entry.getKey(); |
| 148 | + String categoryName = entry.getValue(); |
| 149 | + |
| 150 | + Menu categoryMenu = new Menu(categoryName); |
| 151 | + List<CitationKeyPattern> patterns = categorizedPatterns.getOrDefault(category, List.of()); |
| 152 | + |
| 153 | + for (CitationKeyPattern pattern : patterns) { |
| 154 | + MenuItem menuItem = new MenuItem(pattern.stringRepresentation()); |
| 155 | + menuItem.setOnAction(event -> { |
| 156 | + setText(pattern.stringRepresentation()); |
| 157 | + positionCaret(pattern.stringRepresentation().length()); |
| 158 | + suggestionsList.hide(); |
| 159 | + }); |
| 160 | + categoryMenu.getItems().add(menuItem); |
| 161 | + } |
| 162 | + patternsSubMenu.getItems().add(categoryMenu); |
| 163 | + } |
| 164 | + return patternsSubMenu; |
| 165 | + } |
| 166 | + } |
| 167 | +} |
0 commit comments