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 feature to rename the subgroup, with the keybinding (<kbd>F2</kbd>) for quick access. [#11896](https://github.com/JabRef/jabref/issues/11896)
 - 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)

src/main/java/org/jabref/gui/linkedfile/LinkedFileNamePatternsItemModel.java

@@ -0,0 +1,47 @@
+package org.jabref.gui.linkedfile;
+
+import java.util.Objects;
+
+import javafx.beans.property.ObjectProperty;
+import javafx.beans.property.SimpleObjectProperty;
+import javafx.beans.property.SimpleStringProperty;
+import javafx.beans.property.StringProperty;
+
+import org.jabref.model.entry.types.EntryType;
+
+public class LinkedFileNamePatternsItemModel {
+    private final ObjectProperty<EntryType> entryType = new SimpleObjectProperty<>();
+    private final StringProperty pattern = new SimpleStringProperty("");
+
+    public LinkedFileNamePatternsItemModel(EntryType entryType, String pattern) {
+        Objects.requireNonNull(entryType);
+        Objects.requireNonNull(pattern);
+        this.entryType.setValue(entryType);
+        this.pattern.setValue(pattern);
+    }
+
+    public EntryType getEntryType() {
+        return entryType.getValue();
+    }
+
+    public ObjectProperty<EntryType> entryType() {
+        return entryType;
+    }
+
+    public void setPattern(String pattern) {
+        this.pattern.setValue(pattern);
+    }
+
+    public String getPattern() {
+        return pattern.getValue();
+    }
+
+    public StringProperty pattern() {
+        return pattern;
+    }
+
+    @Override
+    public String toString() {
+        return "[" + entryType.getValue().getName() + "," + pattern.getValue() + "]";
+    }
+}

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>

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

@@ -0,0 +1,138 @@
+package org.jabref.gui.linkedfile;
+
+import java.util.Collection;
+
+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.input.KeyEvent;
+
+import org.jabref.gui.icon.IconTheme;
+import org.jabref.gui.util.ValueTableCellFactory;
+import org.jabref.logic.l10n.Localization;
+import org.jabref.logic.linkedfile.AbstractLinkedFileNamePatterns;
+import org.jabref.logic.linkedfile.LinkedFileNamePattern;
+import org.jabref.model.entry.BibEntryType;
+import org.jabref.model.entry.types.EntryType;
+
+import com.airhacks.afterburner.views.ViewLoader;
+
+public class LinkedFileNamePatternsPanel extends TableView<LinkedFileNamePatternsItemModel> {
+
+    @FXML public TableColumn<LinkedFileNamePatternsItemModel, EntryType> entryTypeColumn;
+    @FXML public TableColumn<LinkedFileNamePatternsItemModel, String> patternColumn;
+    @FXML public TableColumn<LinkedFileNamePatternsItemModel, EntryType> actionsColumn;
+
+    private LinkedFileNamePatternsPanelViewModel viewModel;
+
+    private long lastKeyPressTime;
+    private String tableSearchTerm;
+    private final ObservableList<String> patterns;
+
+    public LinkedFileNamePatternsPanel() {
+        super();
+        this.patterns = FXCollections.observableArrayList(
+                LinkedFileNamePattern.getAllPatterns().stream()
+                                     .map(LinkedFileNamePattern::stringRepresentation)
+                                     .toList()
+        );
+
+        ViewLoader.view(this)
+                  .root(this)
+                  .load();
+    }
+
+    @FXML
+    private void initialize() {
+        viewModel = new LinkedFileNamePatternsPanelViewModel();
+
+        this.setEditable(true);
+
+        entryTypeColumn.setSortable(true);
+        entryTypeColumn.setReorderable(false);
+        entryTypeColumn.setCellValueFactory(cellData -> cellData.getValue().entryType());
+        new ValueTableCellFactory<LinkedFileNamePatternsItemModel, EntryType>()
+                .withText(EntryType::getDisplayName)
+                .install(entryTypeColumn);
+        this.setOnSort(event ->
+                viewModel.patternListProperty().sort(LinkedFileNamePatternsPanelViewModel.defaultOnTopComparator));
+
+        patternColumn.setSortable(true);
+        patternColumn.setReorderable(false);
+        patternColumn.setCellValueFactory(cellData -> cellData.getValue().pattern());
+        patternColumn.setCellFactory(a -> new LinkedFileNamePatternsSuggestionCell(patterns));
+        patternColumn.setEditable(true);
+        patternColumn.setOnEditCommit(
+                (TableColumn.CellEditEvent<LinkedFileNamePatternsItemModel, String> event) ->
+                        event.getRowValue().setPattern(event.getNewValue()));
+
+        actionsColumn.setSortable(false);
+        actionsColumn.setReorderable(false);
+        actionsColumn.setCellValueFactory(cellData -> cellData.getValue().entryType());
+        new ValueTableCellFactory<LinkedFileNamePatternsItemModel, EntryType>()
+                .withGraphic(entryType -> IconTheme.JabRefIcons.REFRESH.getGraphicNode())
+                .withTooltip(entryType ->
+                        Localization.lang("Reset %s to default value").formatted(entryType.getDisplayName()))
+                .withOnMouseClickedEvent(item -> evt ->
+                        viewModel.setItemToDefaultPattern(this.getFocusModel().getFocusedItem()))
+                .install(actionsColumn);
+
+        this.setRowFactory(item -> new HighlightTableRow());
+        this.setOnKeyTyped(this::jumpToSearchKey);
+        this.itemsProperty().bindBidirectional(viewModel.patternListProperty());
+    }
+
+    public void setValues(Collection<BibEntryType> entryTypeList, AbstractLinkedFileNamePatterns keyPattern) {
+        viewModel.setValues(entryTypeList, keyPattern);
+    }
+
+    public void resetAll() {
+        viewModel.resetAll();
+    }
+
+    public ListProperty<LinkedFileNamePatternsItemModel> patternListProperty() {
+        return viewModel.patternListProperty();
+    }
+
+    public ObjectProperty<LinkedFileNamePatternsItemModel> defaultNamePatternProperty() {
+        return viewModel.defaultNamePatternProperty();
+    }
+
+    private void jumpToSearchKey(KeyEvent keypressed) {
+        if (keypressed.getCharacter() == null) {
+            return;
+        }
+
+        if (System.currentTimeMillis() - lastKeyPressTime < 1000) {
+            tableSearchTerm += keypressed.getCharacter().toLowerCase();
+        } else {
+            tableSearchTerm = keypressed.getCharacter().toLowerCase();
+        }
+
+        lastKeyPressTime = System.currentTimeMillis();
+
+        this.getItems().stream().filter(item -> item.getEntryType().getName().toLowerCase().startsWith(tableSearchTerm))
+            .findFirst().ifPresent(this::scrollTo);
+    }
+
+    private static class HighlightTableRow extends TableRow<LinkedFileNamePatternsItemModel> {
+        @Override
+        public void updateItem(LinkedFileNamePatternsItemModel item, boolean empty) {
+            super.updateItem(item, empty);
+            if (item == null || item.getEntryType() == null) {
+                setStyle("");
+            } else if (isSelected()) {
+                setStyle("-fx-background-color: -fx-selection-bar");
+            } else if (LinkedFileNamePatternsPanelViewModel.ENTRY_TYPE_DEFAULT_NAME.equals(item.getEntryType().getName())) {
+                setStyle("-fx-background-color: -fx-default-button");
+            } else {
+                setStyle("");
+            }
+        }
+    }
+}

src/main/java/org/jabref/gui/linkedfile/LinkedFileNamePatternsPanelViewModel.java

@@ -0,0 +1,94 @@
+package org.jabref.gui.linkedfile;
+
+import java.util.Collection;
+import java.util.Comparator;
+
+import javafx.beans.property.ListProperty;
+import javafx.beans.property.ObjectProperty;
+import javafx.beans.property.SimpleListProperty;
+import javafx.beans.property.SimpleObjectProperty;
+import javafx.collections.FXCollections;
+
+import org.jabref.logic.l10n.Localization;
+import org.jabref.logic.linkedfile.AbstractLinkedFileNamePatterns;
+import org.jabref.logic.linkedfile.LinkedFileNamePattern;
+import org.jabref.model.entry.BibEntryType;
+import org.jabref.model.entry.types.EntryType;
+
+public class LinkedFileNamePatternsPanelViewModel {
+    public static final String ENTRY_TYPE_DEFAULT_NAME = "default";
+
+    public static Comparator<LinkedFileNamePatternsItemModel> defaultOnTopComparator = (o1, o2) -> {
+        String itemOneName = o1.getEntryType().getName();
+        String itemTwoName = o2.getEntryType().getName();
+
+        if (itemOneName.equals(itemTwoName)) {
+            return 0;
+        } else if (ENTRY_TYPE_DEFAULT_NAME.equals(itemOneName)) {
+            return -1;
+        } else if (ENTRY_TYPE_DEFAULT_NAME.equals(itemTwoName)) {
+            return 1;
+        }
+
+        return 0;
+    };
+
+    private final ListProperty<LinkedFileNamePatternsItemModel> patternListProperty = new SimpleListProperty<>();
+    private final ObjectProperty<LinkedFileNamePatternsItemModel> defaultItemProperty = new SimpleObjectProperty<>();
+
+    public LinkedFileNamePatternsPanelViewModel() { }
+
+    public void setValues(Collection<BibEntryType> entryTypeList, AbstractLinkedFileNamePatterns initialNamePattern) {
+        String defaultPattern;
+        if ((initialNamePattern.getDefaultValue() == null) || initialNamePattern.getDefaultValue().equals(LinkedFileNamePattern.NULL_LINKED_FILE_NAME_PATTERN)) {
+            defaultPattern = "";
+        } else {
+            defaultPattern = initialNamePattern.getDefaultValue().stringRepresentation();
+        }
+
+        defaultItemProperty.setValue(new LinkedFileNamePatternsItemModel(new DefaultEntryType(), defaultPattern));
+        patternListProperty.setValue(FXCollections.observableArrayList());
+        patternListProperty.add(defaultItemProperty.getValue());
+
+        entryTypeList.stream()
+                     .map(BibEntryType::getType)
+                     .forEach(entryType -> {
+                         String pattern;
+                         if (initialNamePattern.isDefaultValue(entryType)) {
+                             pattern = "";
+                         } else {
+                             pattern = initialNamePattern.getPatterns().get(entryType).stringRepresentation();
+                         }
+                         patternListProperty.add(new LinkedFileNamePatternsItemModel(entryType, pattern));
+                     });
+    }
+
+    public void setItemToDefaultPattern(LinkedFileNamePatternsItemModel item) {
+        item.setPattern(LinkedFileNamePattern.AUTHOR_YEAR.stringRepresentation());
+    }
+
+    public void resetAll() {
+        patternListProperty.forEach(item -> item.setPattern(""));
+        defaultItemProperty.getValue().setPattern(ENTRY_TYPE_DEFAULT_NAME);
+    }
+
+    public ListProperty<LinkedFileNamePatternsItemModel> patternListProperty() {
+        return patternListProperty;
+    }
+
+    public ObjectProperty<LinkedFileNamePatternsItemModel> defaultNamePatternProperty() {
+        return defaultItemProperty;
+    }
+
+    public static class DefaultEntryType implements EntryType {
+        @Override
+        public String getName() {
+            return ENTRY_TYPE_DEFAULT_NAME;
+        }
+
+        @Override
+        public String getDisplayName() {
+            return Localization.lang("Default pattern");
+        }
+    }
+}