Tabular UI for naming linked files

CHANGELOG.md

@@ -11,6 +11,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 
 ### Added
 
+- We added a table for naming linked files in the Linked Files tab in Preferences. [#11368](https://github.com/JabRef/jabref/issues/11368)
 - We added a button in Privacy notice and Mr. DLib Privacy settings notice for hiding related tabs. [#11707](https://github.com/JabRef/jabref/issues/11707)
 - We added buttons "Add example entry" and "Import existing PDFs" when a library is empty, making it easier for new users to get started. [#12662](https://github.com/JabRef/jabref/issues/12662)
 - In the Open/LibreOffice integration, we added the provision to modify the bibliography title and its format for CSL styles, in the "Select style" dialog. [#12663](https://github.com/JabRef/jabref/issues/12663)

docs/code-howtos/cli.md

@@ -0,0 +1,14 @@
+---
+parent: Code Howtos
+---
+# Command Line Interface
+
+The package `org.jabref.cli` is responsible for handling the command line options.
+
+During development, one can configure IntelliJ to pass command line parameters:
+
+![IntelliJ-run-configuration](../images/intellij-run-configuration-command-line.png)
+
+Passing command line arguments using gradle is currently not possible as all arguments (such as `-Dfile.encoding=windows-1252`) are passed to the application.
+
+Without [jlink](https://docs.oracle.com/en/java/javase/11/tools/jlink.html), it is not possible to generate a fat jar anymore. During development, the capabilities of the IDE has to be used.

docs/code-howtos/groups.md

@@ -0,0 +1,6 @@
+---
+parent: Code Howtos
+---
+# Groups
+
+Diagram showing aspects of groups: [Groups.uml](https://github.com/JabRef/jabref/tree/3b3716b1e05a0d3273c886e102a8efe5e96472e0/docs/Groups.uml).

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

@@ -15,7 +15,7 @@
 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.citationkeypattern.KeyPattern;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.logic.preferences.CliPreferences;
 import org.jabref.model.entry.BibEntryType;
@@ -24,11 +24,11 @@
 import com.airhacks.afterburner.views.ViewLoader;
 import jakarta.inject.Inject;
 
-public class CitationKeyPatternsPanel extends TableView<CitationKeyPatternsPanelItemModel> {
+public class CitationKeyPatternsPanel extends TableView<PatternsPanelItemModel> {
 
-    @FXML public TableColumn<CitationKeyPatternsPanelItemModel, EntryType> entryTypeColumn;
-    @FXML public TableColumn<CitationKeyPatternsPanelItemModel, String> patternColumn;
-    @FXML public TableColumn<CitationKeyPatternsPanelItemModel, EntryType> actionsColumn;
+    @FXML public TableColumn<PatternsPanelItemModel, EntryType> entryTypeColumn;
+    @FXML public TableColumn<PatternsPanelItemModel, String> patternColumn;
+    @FXML public TableColumn<PatternsPanelItemModel, EntryType> actionsColumn;
 
     @Inject private CliPreferences preferences;
 
@@ -41,9 +41,9 @@ public class CitationKeyPatternsPanel extends TableView<CitationKeyPatternsPanel
     public CitationKeyPatternsPanel() {
         super();
         this.patterns = FXCollections.observableArrayList(
-                CitationKeyPattern.getAllPatterns().stream()
-                                  .map(CitationKeyPattern::stringRepresentation)
-                                  .toList()
+                KeyPattern.getAllPatterns().stream()
+                          .map(KeyPattern::stringRepresentation)
+                          .toList()
         );
 
         ViewLoader.view(this)
@@ -60,7 +60,7 @@ private void initialize() {
         entryTypeColumn.setSortable(true);
         entryTypeColumn.setReorderable(false);
         entryTypeColumn.setCellValueFactory(cellData -> cellData.getValue().entryType());
-        new ValueTableCellFactory<CitationKeyPatternsPanelItemModel, EntryType>()
+        new ValueTableCellFactory<PatternsPanelItemModel, EntryType>()
                 .withText(EntryType::getDisplayName)
                 .install(entryTypeColumn);
         this.setOnSort(event ->
@@ -69,16 +69,16 @@ private void initialize() {
         patternColumn.setSortable(true);
         patternColumn.setReorderable(false);
         patternColumn.setCellValueFactory(cellData -> cellData.getValue().pattern());
-        patternColumn.setCellFactory(_ -> new CitationKeyPatternSuggestionCell(patterns));
+        patternColumn.setCellFactory(_ -> new PatternSuggestionCell(patterns));
         patternColumn.setEditable(true);
         patternColumn.setOnEditCommit(
-                (TableColumn.CellEditEvent<CitationKeyPatternsPanelItemModel, String> event) ->
+                (TableColumn.CellEditEvent<PatternsPanelItemModel, String> event) ->
                         event.getRowValue().setPattern(event.getNewValue()));
 
         actionsColumn.setSortable(false);
         actionsColumn.setReorderable(false);
         actionsColumn.setCellValueFactory(cellData -> cellData.getValue().entryType());
-        new ValueTableCellFactory<CitationKeyPatternsPanelItemModel, EntryType>()
+        new ValueTableCellFactory<PatternsPanelItemModel, EntryType>()
                 .withGraphic(entryType -> IconTheme.JabRefIcons.REFRESH.getGraphicNode())
                 .withTooltip(entryType ->
                         Localization.lang("Reset %s to default value").formatted(entryType.getDisplayName()))
@@ -99,11 +99,11 @@ public void resetAll() {
         viewModel.resetAll();
     }
 
-    public ListProperty<CitationKeyPatternsPanelItemModel> patternListProperty() {
+    public ListProperty<PatternsPanelItemModel> patternListProperty() {
         return viewModel.patternListProperty();
     }
 
-    public ObjectProperty<CitationKeyPatternsPanelItemModel> defaultKeyPatternProperty() {
+    public ObjectProperty<PatternsPanelItemModel> defaultKeyPatternProperty() {
         return viewModel.defaultKeyPatternProperty();
     }
 
@@ -124,9 +124,9 @@ private void jumpToSearchKey(KeyEvent keypressed) {
             .findFirst().ifPresent(this::scrollTo);
     }
 
-    private static class HighlightTableRow extends TableRow<CitationKeyPatternsPanelItemModel> {
+    private static class HighlightTableRow extends TableRow<PatternsPanelItemModel> {
         @Override
-        public void updateItem(CitationKeyPatternsPanelItemModel item, boolean empty) {
+        public void updateItem(PatternsPanelItemModel item, boolean empty) {
             super.updateItem(item, empty);
             if (item == null || item.getEntryType() == null) {
                 setStyle("");

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

@@ -10,8 +10,8 @@
 import javafx.collections.FXCollections;
 
 import org.jabref.logic.citationkeypattern.AbstractCitationKeyPatterns;
-import org.jabref.logic.citationkeypattern.CitationKeyPattern;
 import org.jabref.logic.citationkeypattern.CitationKeyPatternPreferences;
+import org.jabref.logic.citationkeypattern.KeyPattern;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.entry.BibEntryType;
 import org.jabref.model.entry.types.EntryType;
@@ -20,7 +20,7 @@ public class CitationKeyPatternsPanelViewModel {
 
     public static final String ENTRY_TYPE_DEFAULT_NAME = "default";
 
-    public static Comparator<CitationKeyPatternsPanelItemModel> defaultOnTopComparator = (o1, o2) -> {
+    public static Comparator<PatternsPanelItemModel> defaultOnTopComparator = (o1, o2) -> {
         String itemOneName = o1.getEntryType().getName();
         String itemTwoName = o2.getEntryType().getName();
 
@@ -35,8 +35,8 @@ public class CitationKeyPatternsPanelViewModel {
         return 0;
     };
 
-    private final ListProperty<CitationKeyPatternsPanelItemModel> patternListProperty = new SimpleListProperty<>();
-    private final ObjectProperty<CitationKeyPatternsPanelItemModel> defaultItemProperty = new SimpleObjectProperty<>();
+    private final ListProperty<PatternsPanelItemModel> patternListProperty = new SimpleListProperty<>();
+    private final ObjectProperty<PatternsPanelItemModel> defaultItemProperty = new SimpleObjectProperty<>();
 
     private final CitationKeyPatternPreferences keyPatternPreferences;
 
@@ -46,13 +46,13 @@ public CitationKeyPatternsPanelViewModel(CitationKeyPatternPreferences keyPatter
 
     public void setValues(Collection<BibEntryType> entryTypeList, AbstractCitationKeyPatterns initialKeyPattern) {
         String defaultPattern;
-        if ((initialKeyPattern.getDefaultValue() == null) || initialKeyPattern.getDefaultValue().equals(CitationKeyPattern.NULL_CITATION_KEY_PATTERN)) {
+        if ((initialKeyPattern.getDefaultValue() == null) || initialKeyPattern.getDefaultValue().equals(KeyPattern.NULL_PATTERN)) {
             defaultPattern = "";
         } else {
             defaultPattern = initialKeyPattern.getDefaultValue().stringRepresentation();
         }
 
-        defaultItemProperty.setValue(new CitationKeyPatternsPanelItemModel(new DefaultEntryType(), defaultPattern));
+        defaultItemProperty.setValue(new PatternsPanelItemModel(new DefaultEntryType(), defaultPattern));
         patternListProperty.setValue(FXCollections.observableArrayList());
         patternListProperty.add(defaultItemProperty.getValue());
 
@@ -65,11 +65,11 @@ public void setValues(Collection<BibEntryType> entryTypeList, AbstractCitationKe
                          } else {
                              pattern = initialKeyPattern.getPatterns().get(entryType).stringRepresentation();
                          }
-                         patternListProperty.add(new CitationKeyPatternsPanelItemModel(entryType, pattern));
+                         patternListProperty.add(new PatternsPanelItemModel(entryType, pattern));
                      });
     }
 
-    public void setItemToDefaultPattern(CitationKeyPatternsPanelItemModel item) {
+    public void setItemToDefaultPattern(PatternsPanelItemModel item) {
         item.setPattern(keyPatternPreferences.getDefaultPattern());
     }
 
@@ -78,11 +78,11 @@ public void resetAll() {
         defaultItemProperty.getValue().setPattern(keyPatternPreferences.getDefaultPattern());
     }
 
-    public ListProperty<CitationKeyPatternsPanelItemModel> patternListProperty() {
+    public ListProperty<PatternsPanelItemModel> patternListProperty() {
         return patternListProperty;
     }
 
-    public ObjectProperty<CitationKeyPatternsPanelItemModel> defaultKeyPatternProperty() {
+    public ObjectProperty<PatternsPanelItemModel> defaultKeyPatternProperty() {
         return defaultItemProperty;
     }
 

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

@@ -16,13 +16,13 @@
 import javafx.scene.control.cell.TextFieldTableCell;
 import javafx.stage.Window;
 
-import org.jabref.logic.citationkeypattern.CitationKeyPattern;
+import org.jabref.logic.citationkeypattern.KeyPattern;
 import org.jabref.logic.l10n.Localization;
 
-public class CitationKeyPatternSuggestionCell extends TextFieldTableCell<CitationKeyPatternsPanelItemModel, String> {
+public class PatternSuggestionCell extends TextFieldTableCell<PatternsPanelItemModel, String> {
     private final CitationKeyPatternSuggestionTextField searchField;
 
-    public CitationKeyPatternSuggestionCell(List<String> citationKeyPatterns) {
+    public PatternSuggestionCell(List<String> citationKeyPatterns) {
         this.searchField = new CitationKeyPatternSuggestionTextField(citationKeyPatterns);
         searchField.setOnAction(event -> commitEdit(searchField.getText()));
     }
@@ -145,10 +145,6 @@ public static double getAvailableSpaceBelow(TextField textField) {
             }
 
             Window window = textField.getScene().getWindow();
-            if (window == null) {
-                return 0;
-            }
-
             Bounds bounds = textField.localToScreen(textField.getBoundsInLocal());
             double screenHeight = window.getHeight();
             double textFieldBottom = bounds.getMinY() + textField.getHeight();
@@ -159,26 +155,26 @@ public static double getAvailableSpaceBelow(TextField textField) {
         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<KeyPattern.Category, List<KeyPattern>> categorizedPatterns =
+                    KeyPattern.getAllPatterns().stream()
+                              .collect(Collectors.groupingBy(KeyPattern::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("Entry fields")
+            Map<KeyPattern.Category, String> categoryNames = Map.of(
+                    KeyPattern.Category.AUTHOR_RELATED, Localization.lang("Author related"),
+                    KeyPattern.Category.EDITOR_RELATED, Localization.lang("Editor related"),
+                    KeyPattern.Category.TITLE_RELATED, Localization.lang("Title related"),
+                    KeyPattern.Category.OTHER_FIELDS, Localization.lang("Other fields"),
+                    KeyPattern.Category.BIBENTRY_FIELDS, Localization.lang("Entry fields")
             );
 
-            for (Map.Entry<CitationKeyPattern.Category, String> entry : categoryNames.entrySet()) {
-                CitationKeyPattern.Category category = entry.getKey();
+            for (Map.Entry<KeyPattern.Category, String> entry : categoryNames.entrySet()) {
+                KeyPattern.Category category = entry.getKey();
                 String categoryName = entry.getValue();
 
                 Menu categoryMenu = new Menu(categoryName);
-                List<CitationKeyPattern> patterns = categorizedPatterns.getOrDefault(category, List.of());
+                List<KeyPattern> patterns = categorizedPatterns.getOrDefault(category, List.of());
 
-                for (CitationKeyPattern pattern : patterns) {
+                for (KeyPattern pattern : patterns) {
                     MenuItem menuItem = new MenuItem(pattern.stringRepresentation());
                     menuItem.setOnAction(event -> {
                         setText(pattern.stringRepresentation());

src/main/java/org/jabref/gui/commonfxcontrols/CitationKeyPatternsPanelItemModel.java → src/main/java/org/jabref/gui/commonfxcontrols/PatternsPanelItemModel.java

@@ -9,11 +9,11 @@
 
 import org.jabref.model.entry.types.EntryType;
 
-public class CitationKeyPatternsPanelItemModel {
+public class PatternsPanelItemModel {
     private final ObjectProperty<EntryType> entryType = new SimpleObjectProperty<>();
     private final StringProperty pattern = new SimpleStringProperty("");
 
-    public CitationKeyPatternsPanelItemModel(EntryType entryType, String pattern) {
+    public PatternsPanelItemModel(EntryType entryType, String pattern) {
         Objects.requireNonNull(entryType);
         Objects.requireNonNull(pattern);
         this.entryType.setValue(entryType);

src/main/java/org/jabref/gui/libraryproperties/keypattern/KeyPatternPropertiesViewModel.java

@@ -6,8 +6,8 @@
 import javafx.beans.property.SimpleObjectProperty;
 import javafx.collections.FXCollections;
 
-import org.jabref.gui.commonfxcontrols.CitationKeyPatternsPanelItemModel;
 import org.jabref.gui.commonfxcontrols.CitationKeyPatternsPanelViewModel;
+import org.jabref.gui.commonfxcontrols.PatternsPanelItemModel;
 import org.jabref.gui.libraryproperties.PropertiesTabViewModel;
 import org.jabref.logic.citationkeypattern.DatabaseCitationKeyPatterns;
 import org.jabref.logic.preferences.CliPreferences;
@@ -17,9 +17,9 @@ public class KeyPatternPropertiesViewModel implements PropertiesTabViewModel {
 
     // The list and the default properties are being overwritten by the bound properties of the tableView, but to
     // prevent an NPE on storing the preferences before lazy-loading of the setValues, they need to be initialized.
-    private final ListProperty<CitationKeyPatternsPanelItemModel> patternListProperty = new SimpleListProperty<>(FXCollections.observableArrayList());
-    private final ObjectProperty<CitationKeyPatternsPanelItemModel> defaultKeyPatternProperty = new SimpleObjectProperty<>(
-            new CitationKeyPatternsPanelItemModel(new CitationKeyPatternsPanelViewModel.DefaultEntryType(), ""));
+    private final ListProperty<PatternsPanelItemModel> patternListProperty = new SimpleListProperty<>(FXCollections.observableArrayList());
+    private final ObjectProperty<PatternsPanelItemModel> defaultKeyPatternProperty = new SimpleObjectProperty<>(
+            new PatternsPanelItemModel(new CitationKeyPatternsPanelViewModel.DefaultEntryType(), ""));
 
     private final CliPreferences preferences;
 
@@ -57,11 +57,11 @@ public void storeSettings() {
         databaseContext.getMetaData().setCiteKeyPattern(newKeyPattern);
     }
 
-    public ListProperty<CitationKeyPatternsPanelItemModel> patternListProperty() {
+    public ListProperty<PatternsPanelItemModel> patternListProperty() {
         return patternListProperty;
     }
 
-    public ObjectProperty<CitationKeyPatternsPanelItemModel> defaultKeyPatternProperty() {
+    public ObjectProperty<PatternsPanelItemModel> defaultKeyPatternProperty() {
         return defaultKeyPatternProperty;
     }
 }

src/main/java/org/jabref/gui/linkedfile/LinkedFileNamePatternsPanel.fxml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<?import javafx.scene.control.TableColumn?>
+<?import javafx.scene.control.TableView?>
+<fx:root editable="true" minWidth="280.0" type="TableView"
+         xmlns="http://javafx.com/javafx/11.0.1" xmlns:fx="http://javafx.com/fxml/1"
+         fx:controller="org.jabref.gui.linkedfile.LinkedFileNamePatternsPanel">
+    <columns>
+        <TableColumn fx:id="entryTypeColumn" editable="false" minWidth="100.0" text="%Name"/>
+        <TableColumn fx:id="patternColumn" minWidth="100.0" text="%Key pattern"/>
+        <TableColumn fx:id="actionsColumn" editable="false" maxWidth="30.0" minWidth="30.0" prefWidth="30.0"
+                     reorderable="false" resizable="false" sortable="false"/>
+    </columns>
+    <columnResizePolicy>
+        <TableView fx:constant="CONSTRAINED_RESIZE_POLICY"/>
+    </columnResizePolicy>
+</fx:root>