Add default hierarchical context in group creation as a setting in pr…

…eferences JabRef#9141
roryoday · Oct 29, 2022 · d696367 · d696367
1 parent 93273a3
commit d696367
Show file tree

Hide file tree

Showing 9 changed files with 80 additions and 11 deletions.
diff --git a/src/main/java/org/jabref/gui/groups/GroupDialogViewModel.java b/src/main/java/org/jabref/gui/groups/GroupDialogViewModel.java
@@ -379,7 +379,7 @@ public void setValues() {
             // creating new group -> defaults!
             colorProperty.setValue(IconTheme.getDefaultGroupColor());
             typeExplicitProperty.setValue(true);
-            groupHierarchySelectedProperty.setValue(GroupHierarchyType.INDEPENDENT);
+            groupHierarchySelectedProperty.setValue(preferencesService.getGroupsPreferences().getDefaultGroupMode());
         } else {
             nameProperty.setValue(editedGroup.getName());
             colorProperty.setValue(editedGroup.getColor().orElse(IconTheme.getDefaultGroupColor()));

diff --git a/src/main/java/org/jabref/gui/groups/GroupsPreferences.java b/src/main/java/org/jabref/gui/groups/GroupsPreferences.java
@@ -4,6 +4,7 @@
 import javafx.beans.property.ObjectProperty;
 import javafx.beans.property.SimpleBooleanProperty;
 import javafx.beans.property.SimpleObjectProperty;
+import org.jabref.model.groups.GroupHierarchyType;
 
 public class GroupsPreferences {
 
@@ -12,15 +13,19 @@ public class GroupsPreferences {
     private final BooleanProperty shouldDisplayGroupCount;
     private final ObjectProperty<Character> keywordSeparator;
 
+    private final ObjectProperty<GroupHierarchyType> defaultGroupMode;
+
     public GroupsPreferences(GroupViewMode groupViewMode,
                              boolean shouldAutoAssignGroup,
                              boolean shouldDisplayGroupCount,
-                             ObjectProperty<Character> keywordSeparator) {
+                             ObjectProperty<Character> keywordSeparator,
+                             GroupHierarchyType defaultGroupMode) {
 
         this.groupViewMode = new SimpleObjectProperty<>(groupViewMode);
         this.shouldAutoAssignGroup = new SimpleBooleanProperty(shouldAutoAssignGroup);
         this.shouldDisplayGroupCount = new SimpleBooleanProperty(shouldDisplayGroupCount);
         this.keywordSeparator = keywordSeparator;
+        this.defaultGroupMode = new SimpleObjectProperty<>(defaultGroupMode);
     }
 
     public GroupViewMode getGroupViewMode() {
@@ -70,4 +75,16 @@ public ObjectProperty<Character> keywordSeparatorProperty() {
     public void setKeywordSeparator(Character keywordSeparator) {
         this.keywordSeparator.set(keywordSeparator);
     }
+
+    public GroupHierarchyType getDefaultGroupMode() {
+        return defaultGroupMode.get();
+    }
+
+    public ObjectProperty<GroupHierarchyType> defaultGroupCreateProperty() {
+        return defaultGroupMode;
+    }
+
+    public void setDefaultGroupCreate(GroupHierarchyType defaultGroup){
+        this.defaultGroupMode.set(defaultGroup);
+    }
 }
diff --git a/src/main/java/org/jabref/gui/preferences/groups/GroupsTab.fxml b/src/main/java/org/jabref/gui/preferences/groups/GroupsTab.fxml
@@ -7,6 +7,8 @@
 <?import javafx.scene.control.ToggleGroup?>
 <?import javafx.scene.layout.HBox?>
 <?import javafx.scene.layout.VBox?>
+<?import javafx.scene.control.ComboBox?>
+<?import javafx.scene.layout.GridPane?>
 <fx:root spacing="10.0" type="VBox"
          xmlns="http://javafx.com/javafx" xmlns:fx="http://javafx.com/fxml"
          fx:controller="org.jabref.gui.preferences.groups.GroupsTab">
@@ -23,6 +25,11 @@
     <CheckBox fx:id="autoAssignGroup" text="%Automatically assign new entry to selected groups"/>
     <CheckBox fx:id="displayGroupCount" text="%Display count of items in group"/>
 
+    <GridPane hgap="10.0" vgap="4.0">
+        <Label text="Default Group Creation" GridPane.columnIndex="1" GridPane.rowIndex="1"/>
+        <ComboBox fx:id="defaultSelectionCombo"
+                  prefWidth="200.0" GridPane.columnIndex="2" GridPane.rowIndex="1" />
+    </GridPane>
     <HBox spacing="4" alignment="CENTER_LEFT">
         <Label text="%Keyword separator"/>
         <TextField fx:id="keywordSeparator" minWidth="30.0" maxWidth="30.0"/>

diff --git a/src/main/java/org/jabref/gui/preferences/groups/GroupsTab.java b/src/main/java/org/jabref/gui/preferences/groups/GroupsTab.java
@@ -2,14 +2,17 @@
 
 import javafx.fxml.FXML;
 import javafx.scene.control.CheckBox;
+import javafx.scene.control.ComboBox;
 import javafx.scene.control.RadioButton;
 import javafx.scene.control.TextField;
 
 import org.jabref.gui.preferences.AbstractPreferenceTabView;
 import org.jabref.gui.preferences.PreferencesTab;
+import org.jabref.gui.util.ViewModelListCellFactory;
 import org.jabref.logic.l10n.Localization;
 
 import com.airhacks.afterburner.views.ViewLoader;
+import org.jabref.model.groups.GroupHierarchyType;
 
 public class GroupsTab extends AbstractPreferenceTabView<GroupsTabViewModel> implements PreferencesTab {
 
@@ -19,6 +22,8 @@ public class GroupsTab extends AbstractPreferenceTabView<GroupsTabViewModel> imp
     @FXML private CheckBox displayGroupCount;
     @FXML private TextField keywordSeparator;
 
+    @FXML private ComboBox<GroupHierarchyType> defaultSelectionCombo;
+
     public GroupsTab() {
         ViewLoader.view(this)
                   .root(this)
@@ -33,6 +38,14 @@ public String getTabName() {
     public void initialize() {
         this.viewModel = new GroupsTabViewModel(dialogService, preferencesService.getGroupsPreferences());
 
+        new ViewModelListCellFactory<GroupHierarchyType>()
+                .withText(GroupHierarchyType::getFormattedName)
+                .install(defaultSelectionCombo);
+
+        defaultSelectionCombo.itemsProperty().bind(viewModel.defaultGroupsListProperty());
+        defaultSelectionCombo.valueProperty().bindBidirectional(viewModel.selectedDefaultGroup());
+
+
         groupViewModeIntersection.selectedProperty().bindBidirectional(viewModel.groupViewModeIntersectionProperty());
         groupViewModeUnion.selectedProperty().bindBidirectional(viewModel.groupViewModeUnionProperty());
         autoAssignGroup.selectedProperty().bindBidirectional(viewModel.autoAssignGroupProperty());

diff --git a/src/main/java/org/jabref/gui/preferences/groups/GroupsTabViewModel.java b/src/main/java/org/jabref/gui/preferences/groups/GroupsTabViewModel.java
@@ -1,14 +1,13 @@
 package org.jabref.gui.preferences.groups;
 
-import javafx.beans.property.BooleanProperty;
-import javafx.beans.property.SimpleBooleanProperty;
-import javafx.beans.property.SimpleStringProperty;
-import javafx.beans.property.StringProperty;
+import javafx.beans.property.*;
 
+import javafx.collections.FXCollections;
 import org.jabref.gui.DialogService;
 import org.jabref.gui.groups.GroupViewMode;
 import org.jabref.gui.groups.GroupsPreferences;
 import org.jabref.gui.preferences.PreferenceTabViewModel;
+import org.jabref.model.groups.GroupHierarchyType;
 
 public class GroupsTabViewModel implements PreferenceTabViewModel {
 
@@ -17,6 +16,9 @@ public class GroupsTabViewModel implements PreferenceTabViewModel {
     private final BooleanProperty autoAssignGroupProperty = new SimpleBooleanProperty();
     private final BooleanProperty displayGroupCountProperty = new SimpleBooleanProperty();
     private final StringProperty keywordSeparatorProperty = new SimpleStringProperty("");
+    private final ListProperty<GroupHierarchyType> groupDefaultListProperty = new SimpleListProperty<>();
+
+    private final ObjectProperty<GroupHierarchyType> selectedGroupDefaultProperty = new SimpleObjectProperty<>();
 
     private final DialogService dialogService;
     private final GroupsPreferences groupsPreferences;
@@ -38,6 +40,10 @@ public void setValues() {
                 groupViewModeUnionProperty.setValue(true);
             }
         }
+        groupDefaultListProperty.setValue(FXCollections.observableArrayList(GroupHierarchyType.values()));
+        selectedGroupDefaultProperty.setValue(groupsPreferences.getDefaultGroupMode());
+
+
         autoAssignGroupProperty.setValue(groupsPreferences.shouldAutoAssignGroup());
         displayGroupCountProperty.setValue(groupsPreferences.shouldDisplayGroupCount());
         keywordSeparatorProperty.setValue(groupsPreferences.getKeywordSeparator().toString());
@@ -49,6 +55,7 @@ public void storeSettings() {
         groupsPreferences.setAutoAssignGroup(autoAssignGroupProperty.getValue());
         groupsPreferences.setDisplayGroupCount(displayGroupCountProperty.getValue());
         groupsPreferences.keywordSeparatorProperty().setValue(keywordSeparatorProperty.getValue().charAt(0));
+        groupsPreferences.setDefaultGroupCreate(selectedGroupDefaultProperty.getValue());
     }
 
     public BooleanProperty groupViewModeIntersectionProperty() {
@@ -70,4 +77,12 @@ public BooleanProperty displayGroupCount() {
     public StringProperty keywordSeparatorProperty() {
         return keywordSeparatorProperty;
     }
+
+    public ListProperty<GroupHierarchyType> defaultGroupsListProperty() {
+        return this.groupDefaultListProperty;
+    }
+
+    public Property<GroupHierarchyType> selectedDefaultGroup() {
+        return this.selectedGroupDefaultProperty;
+    }
 }
diff --git a/src/main/java/org/jabref/model/groups/GroupHierarchyType.java b/src/main/java/org/jabref/model/groups/GroupHierarchyType.java
@@ -29,4 +29,15 @@ public static GroupHierarchyType getByNumberOrDefault(int type) {
             return INDEPENDENT;
         }
     }
+
+    public String getFormattedName() {
+        if (this == INDEPENDENT) {
+            return "Independent";
+        } else if (this == REFINING) {
+            return "Intersection";
+        }
+        else {
+            return "Union";
+        }
+    }
 }
diff --git a/src/main/java/org/jabref/preferences/JabRefPreferences.java b/src/main/java/org/jabref/preferences/JabRefPreferences.java
@@ -111,6 +111,7 @@
 import org.jabref.model.entry.field.StandardField;
 import org.jabref.model.entry.types.EntryType;
 import org.jabref.model.entry.types.EntryTypeFactory;
+import org.jabref.model.groups.GroupHierarchyType;
 import org.jabref.model.metadata.SaveOrderConfig;
 import org.jabref.model.search.rules.SearchRules;
 import org.jabref.model.strings.StringUtil;
@@ -376,6 +377,8 @@ public class JabRefPreferences implements PreferencesService {
     // GroupViewMode
     private static final String GROUP_INTERSECT_UNION_VIEW_MODE = "groupIntersectUnionViewModes";
 
+    private static final String GROUP_CREATE_DEFAULT = "groupCreateDefault";
+
     // Dialog states
     private static final String PREFS_EXPORT_PATH = "prefsExportPath";
     private static final String DOWNLOAD_LINKED_FILES = "downloadLinkedFiles";
@@ -602,7 +605,9 @@ private JabRefPreferences() {
         defaults.put(AUTO_ASSIGN_GROUP, Boolean.TRUE);
         defaults.put(DISPLAY_GROUP_COUNT, Boolean.TRUE);
         defaults.put(GROUP_INTERSECT_UNION_VIEW_MODE, GroupViewMode.INTERSECTION.name());
+
         defaults.put(KEYWORD_SEPARATOR, ", ");
+        defaults.put(GROUP_CREATE_DEFAULT, GroupHierarchyType.INDEPENDENT.name());
         defaults.put(DEFAULT_ENCODING, StandardCharsets.UTF_8.name());
         defaults.put(DEFAULT_OWNER, System.getProperty("user.name"));
         defaults.put(MEMORY_STICK_MODE, Boolean.FALSE);
@@ -1387,12 +1392,13 @@ public GroupsPreferences getGroupsPreferences() {
                 GroupViewMode.valueOf(get(GROUP_INTERSECT_UNION_VIEW_MODE)),
                 getBoolean(AUTO_ASSIGN_GROUP),
                 getBoolean(DISPLAY_GROUP_COUNT),
-                getInternalPreferences().keywordSeparatorProperty()
-        );
+                getInternalPreferences().keywordSeparatorProperty(),
+                GroupHierarchyType.valueOf(get(GROUP_CREATE_DEFAULT)));
 
         EasyBind.listen(groupsPreferences.groupViewModeProperty(), (obs, oldValue, newValue) -> put(GROUP_INTERSECT_UNION_VIEW_MODE, newValue.name()));
         EasyBind.listen(groupsPreferences.autoAssignGroupProperty(), (obs, oldValue, newValue) -> putBoolean(AUTO_ASSIGN_GROUP, newValue));
         EasyBind.listen(groupsPreferences.displayGroupCountProperty(), (obs, oldValue, newValue) -> putBoolean(DISPLAY_GROUP_COUNT, newValue));
+        EasyBind.listen(groupsPreferences.defaultGroupCreateProperty(), (obs, oldValue, newValue) -> put(GROUP_CREATE_DEFAULT, newValue.name()));
         // KeywordSeparator is handled by JabRefPreferences::getInternalPreferences
 
         return groupsPreferences;

diff --git a/src/test/java/org/jabref/gui/groups/GroupNodeViewModelTest.java b/src/test/java/org/jabref/gui/groups/GroupNodeViewModelTest.java
@@ -49,8 +49,8 @@ void setUp() {
                 GroupViewMode.UNION,
                 true,
                 true,
-                new SimpleObjectProperty<>(',')
-        ));
+                new SimpleObjectProperty<>(','),
+                GroupHierarchyType.INDEPENDENT));
 
         viewModel = getViewModelForGroup(
                 new WordKeywordGroup("Test group", GroupHierarchyType.INDEPENDENT, StandardField.TITLE, "search", true, ',', false));

diff --git a/src/test/java/org/jabref/gui/groups/GroupTreeViewModelTest.java b/src/test/java/org/jabref/gui/groups/GroupTreeViewModelTest.java
@@ -51,7 +51,7 @@ void setUp() {
                                                                                          GroupViewMode.UNION,
                                                                                          true,
                                                                                          true,
-                                                                                         new SimpleObjectProperty<>(',')));
+                                                                                         new SimpleObjectProperty<>(','), GroupHierarchyType.getByNumberOrDefault(0)));
         groupTree = new GroupTreeViewModel(stateManager, mock(DialogService.class), preferencesService, taskExecutor, new CustomLocalDragboard());
     }