Add drop down for citation key patterns

CHANGELOG.md

@@ -11,6 +11,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 
 ### Added
 
+- We added a new functionality that displays a drop-down list of matching suggestions when typing a citation key pattern. [#12502](https://github.com/JabRef/jabref/issues/12502)
 - We added a new CLI that supports txt, csv, and console-based output for consistency in BibTeX entries. [#11984](https://github.com/JabRef/jabref/issues/11984)
 - We added a new dialog for bibliography consistency check. [#11950](https://github.com/JabRef/jabref/issues/11950)
 - We added a feature for copying entries to libraries, available via the context menu, with an option to include cross-references. [#12374](https://github.com/JabRef/jabref/pull/12374)

src/main/java/org/jabref/gui/commonfxcontrols/CitationKeyPatternSuggestionCell.java

@@ -0,0 +1,167 @@
+package org.jabref.gui.commonfxcontrols;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+import javafx.scene.control.ContextMenu;
+import javafx.scene.control.CustomMenuItem;
+import javafx.scene.control.Label;
+import javafx.scene.control.Menu;
+import javafx.scene.control.MenuItem;
+import javafx.scene.control.TextField;
+import javafx.scene.control.cell.TextFieldTableCell;
+
+import org.jabref.logic.citationkeypattern.CitationKeyPattern;
+import org.jabref.logic.l10n.Localization;
+
+public class CitationKeyPatternSuggestionCell extends TextFieldTableCell<CitationKeyPatternsPanelItemModel, String> {
+    private final CitationKeyPatternSuggestionTextField searchField;
+
+    public CitationKeyPatternSuggestionCell(List<String> citationKeyPatterns) {
+        this.searchField = new CitationKeyPatternSuggestionTextField(citationKeyPatterns);
+        searchField.setOnAction(event -> commitEdit(searchField.getText()));
+    }
+
+    @Override
+    public void startEdit() {
+        super.startEdit();
+        searchField.setText(getItem());
+        setGraphic(searchField);
+        searchField.requestFocus();
+    }
+
+    @Override
+    public void cancelEdit() {
+        super.cancelEdit();
+        setGraphic(null);
+    }
+
+    @Override
+    public void commitEdit(String newValue) {
+        super.commitEdit(newValue);
+        getTableView().getItems().get(getIndex()).setPattern(newValue);
+        setGraphic(null);
+    }
+
+    @Override
+    public void updateItem(String item, boolean empty) {
+        super.updateItem(item, empty);
+        if (empty || item == null) {
+            setGraphic(null);
+            setText(null);
+        } else {
+            setText(item);
+        }
+    }
+
+    static class CitationKeyPatternSuggestionTextField extends TextField {
+        // Maximum number of entries that can be displayed in the popup menu.
+        private static final int MAX_ENTRIES = 7;
+
+        private final List<String> citationKeyPatterns;
+        private final ContextMenu suggestionsList;
+
+        public CitationKeyPatternSuggestionTextField(List<String> citationKeyPatterns) {
+            this.citationKeyPatterns = new ArrayList<>(citationKeyPatterns);
+            this.suggestionsList = new ContextMenu();
+
+            setListener();
+        }
+
+        private void setListener() {
+            textProperty().addListener((observable, oldValue, newValue) -> {
+                String enteredText = getText();
+                if (enteredText == null || enteredText.isEmpty()) {
+                    suggestionsList.hide();
+                } else {
+                    List<String> filteredEntries = citationKeyPatterns.stream()
+                                                                      .filter(e -> e.toLowerCase().contains(enteredText.toLowerCase()))
+                                                                      .collect(Collectors.toList());
+
+                    if (!filteredEntries.isEmpty()) {
+                        populatePopup(filteredEntries);
+                        if (!suggestionsList.isShowing() && getScene() != null) {
+                            double screenX = localToScreen(0, 0).getX();
+                            double screenY = localToScreen(0, 0).getY() + getHeight();
+                            suggestionsList.show(this, screenX, screenY);
+                        }
+                    } else {
+                        suggestionsList.hide();
+                    }
+                }
+            });
+
+            focusedProperty().addListener((observable, oldValue, newValue) -> {
+                suggestionsList.hide();
+            });
+        }
+
+        private void populatePopup(List<String> searchResult) {
+            List<CustomMenuItem> menuItems = new ArrayList<>();
+            int count = Math.min(searchResult.size(), MAX_ENTRIES);
+
+            for (int i = 0; i < count; i++) {
+                final String result = searchResult.get(i);
+                Label entryLabel = new Label(result);
+                entryLabel.setPrefWidth(getWidth());
+
+                CustomMenuItem item = new CustomMenuItem(entryLabel, true);
+                item.setHideOnClick(false);
+
+                menuItems.add(item);
+
+                item.setOnAction(actionEvent -> {
+                    setText(result);
+                    positionCaret(result.length());
+                    suggestionsList.hide();
+                });
+            }
+
+            suggestionsList.getItems().clear();
+            suggestionsList.getItems().add(createPatternsSubMenu());
+            suggestionsList.getItems().addAll(menuItems);
+
+            if (!menuItems.isEmpty()) {
+                menuItems.getFirst().getContent().requestFocus();
+            }
+        }
+
+        private Menu createPatternsSubMenu() {
+            Menu patternsSubMenu = new Menu(Localization.lang("All patterns"));
+
+            Map<CitationKeyPattern.Category, List<CitationKeyPattern>> categorizedPatterns =
+                    CitationKeyPattern.getAllPatterns().stream()
+                                      .collect(Collectors.groupingBy(CitationKeyPattern::getCategory));
+
+            Map<CitationKeyPattern.Category, String> categoryNames = Map.of(
+                    CitationKeyPattern.Category.AUTHOR_RELATED, Localization.lang("Author related"),
+                    CitationKeyPattern.Category.EDITOR_RELATED, Localization.lang("Editor related"),
+                    CitationKeyPattern.Category.TITLE_RELATED, Localization.lang("Title related"),
+                    CitationKeyPattern.Category.OTHER_FIELDS, Localization.lang("Other fields"),
+                    CitationKeyPattern.Category.BIBENTRY_FIELDS, Localization.lang("BibEntry fields")
+            );
+
+            for (Map.Entry<CitationKeyPattern.Category, String> entry : categoryNames.entrySet()) {
+                CitationKeyPattern.Category category = entry.getKey();
+                String categoryName = entry.getValue();
+
+                Menu categoryMenu = new Menu(categoryName);
+                List<CitationKeyPattern> patterns = categorizedPatterns.getOrDefault(category, List.of());
+
+                for (CitationKeyPattern pattern : patterns) {
+                    MenuItem menuItem = new MenuItem(pattern.stringRepresentation());
+                    menuItem.setOnAction(event -> {
+                        setText(pattern.stringRepresentation());
+                        positionCaret(pattern.stringRepresentation().length());
+                        suggestionsList.hide();
+                    });
+                    categoryMenu.getItems().add(menuItem);
+                }
+                patternsSubMenu.getItems().add(categoryMenu);
+            }
+            return patternsSubMenu;
+        }
+    }
+}

src/main/java/org/jabref/gui/commonfxcontrols/CitationKeyPatternsPanel.java

@@ -4,16 +4,18 @@
 
 import javafx.beans.property.ListProperty;
 import javafx.beans.property.ObjectProperty;
+import javafx.collections.FXCollections;
+import javafx.collections.ObservableList;
 import javafx.fxml.FXML;
 import javafx.scene.control.TableColumn;
 import javafx.scene.control.TableRow;
 import javafx.scene.control.TableView;
-import javafx.scene.control.cell.TextFieldTableCell;
 import javafx.scene.input.KeyEvent;
 
 import org.jabref.gui.icon.IconTheme;
 import org.jabref.gui.util.ValueTableCellFactory;
 import org.jabref.logic.citationkeypattern.AbstractCitationKeyPatterns;
+import org.jabref.logic.citationkeypattern.CitationKeyPattern;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.logic.preferences.CliPreferences;
 import org.jabref.model.entry.BibEntryType;
@@ -34,9 +36,15 @@ public class CitationKeyPatternsPanel extends TableView<CitationKeyPatternsPanel
 
     private long lastKeyPressTime;
     private String tableSearchTerm;
+    private final ObservableList<String> patterns;
 
     public CitationKeyPatternsPanel() {
         super();
+        this.patterns = FXCollections.observableArrayList(
+                CitationKeyPattern.getAllPatterns().stream()
+                                  .map(CitationKeyPattern::stringRepresentation)
+                                  .toList()
+        );
 
         ViewLoader.view(this)
                   .root(this)
@@ -61,7 +69,7 @@ private void initialize() {
         patternColumn.setSortable(true);
         patternColumn.setReorderable(false);
         patternColumn.setCellValueFactory(cellData -> cellData.getValue().pattern());
-        patternColumn.setCellFactory(TextFieldTableCell.forTableColumn());
+        patternColumn.setCellFactory(_ -> new CitationKeyPatternSuggestionCell(patterns));
         patternColumn.setEditable(true);
         patternColumn.setOnEditCommit(
                 (TableColumn.CellEditEvent<CitationKeyPatternsPanelItemModel, String> event) ->

src/main/java/org/jabref/logic/citationkeypattern/CitationKeyPattern.java

@@ -1,5 +1,105 @@
 package org.jabref.logic.citationkeypattern;
 
-public record CitationKeyPattern(String stringRepresentation) {
-    public static final CitationKeyPattern NULL_CITATION_KEY_PATTERN = new CitationKeyPattern("");
+import java.lang.reflect.Modifier;
+import java.util.Arrays;
+import java.util.List;
+import java.util.stream.Collectors;
+
+public record CitationKeyPattern(String stringRepresentation, Category category) {
+    public enum Category {
+        AUTHOR_RELATED, EDITOR_RELATED, TITLE_RELATED, OTHER_FIELDS, BIBENTRY_FIELDS
+    }
+
+    public static final CitationKeyPattern NULL_CITATION_KEY_PATTERN = new CitationKeyPattern("", Category.OTHER_FIELDS);
+
+    // region - Author-related field markers
+    public static final CitationKeyPattern AUTHOR_YEAR = new CitationKeyPattern("[auth_year]", Category.AUTHOR_RELATED);
+    public static final CitationKeyPattern AUTHOR_FIRST_FULL = new CitationKeyPattern("[authFirstFull]", Category.AUTHOR_RELATED);
+    public static final CitationKeyPattern AUTHOR_FORE_INI = new CitationKeyPattern("[authForeIni]", Category.AUTHOR_RELATED);
+    public static final CitationKeyPattern AUTHOR_ETAL = new CitationKeyPattern("[auth.etal]", Category.AUTHOR_RELATED);
+    public static final CitationKeyPattern AUTHOR_ET_AL = new CitationKeyPattern("[authEtAl]", Category.AUTHOR_RELATED);
+    public static final CitationKeyPattern AUTHOR_AUTH_EA = new CitationKeyPattern("[auth.auth.ea]", Category.AUTHOR_RELATED);
+    public static final CitationKeyPattern AUTHORS = new CitationKeyPattern("[authors]", Category.AUTHOR_RELATED);
+    public static final CitationKeyPattern AUTHORS_N = new CitationKeyPattern("[authorsN]", Category.AUTHOR_RELATED);
+    public static final CitationKeyPattern AUTH_INI_N = new CitationKeyPattern("[authIniN]", Category.AUTHOR_RELATED);
+    public static final CitationKeyPattern AUTH_N = new CitationKeyPattern("[authN]", Category.AUTHOR_RELATED);
+    public static final CitationKeyPattern AUTH_N_M = new CitationKeyPattern("[authN_M]", Category.AUTHOR_RELATED);
+    public static final CitationKeyPattern AUTHOR_INI = new CitationKeyPattern("[authorIni]", Category.AUTHOR_RELATED);
+    public static final CitationKeyPattern AUTH_SHORT = new CitationKeyPattern("[authshort]", Category.AUTHOR_RELATED);
+    public static final CitationKeyPattern AUTHORS_ALPHA = new CitationKeyPattern("[authorsAlpha]", Category.AUTHOR_RELATED);
+    public static final CitationKeyPattern AUTHORS_ALPHA_LNI = new CitationKeyPattern("[authorsAlphaLNI]", Category.AUTHOR_RELATED);
+    public static final CitationKeyPattern AUTHORS_LAST = new CitationKeyPattern("[authorsLast]", Category.AUTHOR_RELATED);
+    public static final CitationKeyPattern AUTHORS_LAST_FORE_INI = new CitationKeyPattern("[authorsLastForeIni]", Category.AUTHOR_RELATED);
+    // endregion
+
+    // region - Editor-related field markers
+    public static final CitationKeyPattern EDTR = new CitationKeyPattern("[edtr]", Category.EDITOR_RELATED);
+    public static final CitationKeyPattern EDTR_INI_N = new CitationKeyPattern("[edtrIniN]", Category.EDITOR_RELATED);
+    public static final CitationKeyPattern EDITORS = new CitationKeyPattern("[editors]", Category.EDITOR_RELATED);
+    public static final CitationKeyPattern EDITOR_LAST = new CitationKeyPattern("[editorLast]", Category.EDITOR_RELATED);
+    public static final CitationKeyPattern EDITOR_INI = new CitationKeyPattern("[editorIni]", Category.EDITOR_RELATED);
+    public static final CitationKeyPattern EDTR_N = new CitationKeyPattern("[edtrN]", Category.EDITOR_RELATED);
+    public static final CitationKeyPattern EDTR_N_M = new CitationKeyPattern("[edtrN_M]", Category.EDITOR_RELATED);
+    public static final CitationKeyPattern EDTR_EDTR_EA = new CitationKeyPattern("[edtr.edtr.ea]", Category.EDITOR_RELATED);
+    public static final CitationKeyPattern EDTRSHORT = new CitationKeyPattern("[edtrshort]", Category.EDITOR_RELATED);
+    public static final CitationKeyPattern EDTR_FORE_INI = new CitationKeyPattern("[edtrForeIni]", Category.EDITOR_RELATED);
+    public static final CitationKeyPattern EDITOR_LAST_FORE_INI = new CitationKeyPattern("[editorLastForeIni]", Category.EDITOR_RELATED);
+    // endregion
+
+    // region - Title-related field markers
+    public static final CitationKeyPattern SHORTTITLE = new CitationKeyPattern("[shorttitle]", Category.TITLE_RELATED);
+    public static final CitationKeyPattern SHORTTITLE_INI = new CitationKeyPattern("[shorttitleINI]", Category.TITLE_RELATED);
+    public static final CitationKeyPattern VERYSHORTTITLE = new CitationKeyPattern("[veryshorttitle]", Category.TITLE_RELATED);
+    public static final CitationKeyPattern CAMEL = new CitationKeyPattern("[camel]", Category.TITLE_RELATED);
+    public static final CitationKeyPattern CAMEL_N = new CitationKeyPattern("[camelN]", Category.TITLE_RELATED);
+    public static final CitationKeyPattern TITLE = new CitationKeyPattern("[title]", Category.TITLE_RELATED);
+    public static final CitationKeyPattern FULLTITLE = new CitationKeyPattern("[fulltitle]", Category.TITLE_RELATED);
+    // endregion
+
+    // region - Other field markers
+    public static final CitationKeyPattern ENTRYTYPE = new CitationKeyPattern("[entrytype]", Category.OTHER_FIELDS);
+    public static final CitationKeyPattern FIRSTPAGE = new CitationKeyPattern("[firstpage]", Category.OTHER_FIELDS);
+    public static final CitationKeyPattern PAGEPREFIX = new CitationKeyPattern("[pageprefix]", Category.OTHER_FIELDS);
+    public static final CitationKeyPattern KEYWORD_N = new CitationKeyPattern("[keywordN]", Category.OTHER_FIELDS);
+    public static final CitationKeyPattern KEYWORDS_N = new CitationKeyPattern("[keywordsN]", Category.OTHER_FIELDS);
+    public static final CitationKeyPattern LASTPAGE = new CitationKeyPattern("[lastpage]", Category.OTHER_FIELDS);
+    public static final CitationKeyPattern SHORTYEAR = new CitationKeyPattern("[shortyear]", Category.OTHER_FIELDS);
+    // endregion
+
+    // region - Bibentry fields
+    public static final CitationKeyPattern AUTHOR = new CitationKeyPattern("[AUTHOR]", Category.BIBENTRY_FIELDS);
+    public static final CitationKeyPattern DATE = new CitationKeyPattern("[DATE]", Category.BIBENTRY_FIELDS);
+    public static final CitationKeyPattern DAY = new CitationKeyPattern("[DAY]", Category.BIBENTRY_FIELDS);
+    public static final CitationKeyPattern GROUPS = new CitationKeyPattern("[GROUPS]", Category.BIBENTRY_FIELDS);
+    public static final CitationKeyPattern MONTH = new CitationKeyPattern("[MONTH]", Category.BIBENTRY_FIELDS);
+    public static final CitationKeyPattern YEAR = new CitationKeyPattern("[YEAR]", Category.BIBENTRY_FIELDS);
+    // endregion
+
+    public CitationKeyPattern(String stringRepresentation) {
+        this(stringRepresentation, Category.OTHER_FIELDS);
+    }
+
+    public static List<CitationKeyPattern> getAllPatterns() {
+        return Arrays.stream(CitationKeyPattern.class.getDeclaredFields())
+                     .filter(field -> {
+                         int modifiers = field.getModifiers();
+                         return Modifier.isPublic(modifiers) &&
+                                 Modifier.isStatic(modifiers) &&
+                                 Modifier.isFinal(modifiers) &&
+                                 field.getType() == CitationKeyPattern.class &&
+                                 !field.equals(CitationKeyPattern.NULL_CITATION_KEY_PATTERN);
+                     })
+                     .map(field -> {
+                         try {
+                             return (CitationKeyPattern) field.get(null);
+                         } catch (IllegalAccessException e) {
+                             throw new RuntimeException("Could not access field", e);
+                         }
+                     })
+                     .collect(Collectors.toList());
+    }
+
+    public Category getCategory() {
+        return this.category;
+    }
 }

src/main/resources/l10n/JabRef_en.properties

@@ -2856,3 +2856,9 @@ Include\ or\ exclude\ cross-referenced\ entries=Include or exclude cross-referen
 Would\ you\ like\ to\ include\ cross-reference\ entries\ in\ the\ current\ operation?=Would you like to include cross-reference entries in the current operation?
 Entries\ copied\ successfully,\ including\ cross-references.=Entries copied successfully, including cross-references.
 Entries\ copied\ successfully,\ without\ cross-references.=Entries copied successfully, without cross-references.
+
+All\ patterns=All patterns
+Author\ related=Author related
+Editor\ related=Editor related
+Title\ related=Title related
+BibEntry\ fields=BibEntry fields