Add sorting of all groups and subgroups, recursively (#2666)

* Add sorting of all groups and subgroups, recursively For #2599 * Fix formattiong * Change localization * change localilaztion * Add sort subgroups recursively
JabRef · Apr 7, 2017 · c2fe388 · c2fe388
1 parent 8f3f526
commit c2fe388
Show file tree

Hide file tree

Showing 21 changed files with 64 additions and 11 deletions.
diff --git a/src/main/java/org/jabref/gui/groups/GroupTreeController.java b/src/main/java/org/jabref/gui/groups/GroupTreeController.java
@@ -242,11 +242,17 @@ private ContextMenu createContextMenuForGroup(GroupNodeViewModel group) {
         MenuItem removeEntries = new MenuItem(Localization.lang("Remove selected entries from this group"));
         removeSubgroups.setOnAction(event -> viewModel.removeSelectedEntries(group));
 
+        MenuItem sortAlphabetically = new MenuItem(Localization.lang("Sort all subgroups (recursively)"));
+        sortAlphabetically.setOnAction(event -> viewModel.sortAlphabeticallyRecursive(group));
+
         menu.getItems().add(editGroup);
         menu.getItems().add(new SeparatorMenuItem());
         menu.getItems().addAll(addSubgroup, removeSubgroups, removeGroupAndSubgroups, removeGroupKeepSubgroups);
         menu.getItems().add(new SeparatorMenuItem());
         menu.getItems().addAll(addEntries, removeEntries);
+        menu.getItems().add(new SeparatorMenuItem());
+        menu.getItems().add(sortAlphabetically);
+
         return menu;
     }
 

diff --git a/src/main/java/org/jabref/gui/groups/GroupTreeViewModel.java b/src/main/java/org/jabref/gui/groups/GroupTreeViewModel.java
@@ -1,5 +1,6 @@
 package org.jabref.gui.groups;
 
+import java.util.Comparator;
 import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
@@ -33,18 +34,23 @@ public class GroupTreeViewModel extends AbstractViewModel {
     private final ObjectProperty<Predicate<GroupNodeViewModel>> filterPredicate = new SimpleObjectProperty<>();
     private final StringProperty filterText = new SimpleStringProperty();
     private Optional<BibDatabaseContext> currentDatabase;
+    private final Comparator<GroupTreeNode> compAlphabetIgnoreCase = (GroupTreeNode v1, GroupTreeNode v2) -> v1
+            .getName()
+            .compareToIgnoreCase(v2.getName());
 
     public GroupTreeViewModel(StateManager stateManager, DialogService dialogService, TaskExecutor taskExecutor) {
         this.stateManager = Objects.requireNonNull(stateManager);
         this.dialogService = Objects.requireNonNull(dialogService);
         this.taskExecutor = Objects.requireNonNull(taskExecutor);
 
         // Register listener
-        stateManager.activeDatabaseProperty().addListener((observable, oldValue, newValue) -> onActiveDatabaseChanged(newValue));
+        stateManager.activeDatabaseProperty()
+                .addListener((observable, oldValue, newValue) -> onActiveDatabaseChanged(newValue));
         selectedGroup.addListener((observable, oldValue, newValue) -> onSelectedGroupChanged(newValue));
 
         // Set-up bindings
-        filterPredicate.bind(Bindings.createObjectBinding(() -> group -> group.isMatchedBy(filterText.get()), filterText));
+        filterPredicate
+                .bind(Bindings.createObjectBinding(() -> group -> group.isMatchedBy(filterText.get()), filterText));
 
         // Init
         onActiveDatabaseChanged(stateManager.activeDatabaseProperty().getValue());
@@ -106,7 +112,8 @@ private void onActiveDatabaseChanged(Optional<BibDatabaseContext> newDatabase) {
 
             rootGroup.setValue(newRoot);
             stateManager.getSelectedGroup(newDatabase.get()).ifPresent(
-                    selectedGroup -> this.selectedGroup.setValue(new GroupNodeViewModel(newDatabase.get(), stateManager, taskExecutor, selectedGroup)));
+                    selectedGroup -> this.selectedGroup.setValue(
+                            new GroupNodeViewModel(newDatabase.get(), stateManager, taskExecutor, selectedGroup)));
         }
 
         currentDatabase = newDatabase;
@@ -135,19 +142,19 @@ public void addNewSubgroup(GroupNodeViewModel parent) {
      * Opens "Edit Group Dialog" and changes the given group to the edited one.
      */
     public void editGroup(GroupNodeViewModel oldGroup) {
-        Optional<AbstractGroup> newGroup = dialogService.showCustomDialogAndWait(new GroupDialog(oldGroup.getGroupNode().getGroup()));
+        Optional<AbstractGroup> newGroup = dialogService
+                .showCustomDialogAndWait(new GroupDialog(oldGroup.getGroupNode().getGroup()));
         newGroup.ifPresent(group -> {
 
             // TODO: Keep assignments
             boolean keepPreviousAssignments = dialogService.showConfirmationDialogAndWait(
                     Localization.lang("Change of Grouping Method"),
                     Localization.lang("Assign the original group's entries to this group?"));
             //        WarnAssignmentSideEffects.warnAssignmentSideEffects(newGroup, panel.frame());
-            boolean removePreviousAssignents =
-                    (oldGroup.getGroupNode().getGroup() instanceof ExplicitGroup) && (group instanceof ExplicitGroup);
+            boolean removePreviousAssignents = (oldGroup.getGroupNode().getGroup() instanceof ExplicitGroup)
+                    && (group instanceof ExplicitGroup);
 
-            List<FieldChange> addChange = oldGroup.
-                    getGroupNode().setGroup(
+            List<FieldChange> addChange = oldGroup.getGroupNode().setGroup(
                     group,
                     keepPreviousAssignments,
                     removePreviousAssignents,
@@ -197,15 +204,14 @@ public void removeGroupKeepSubgroups(GroupNodeViewModel group) {
             //final UndoableAddOrRemoveGroup undo = new UndoableAddOrRemoveGroup(groupsRoot, node, UndoableAddOrRemoveGroup.REMOVE_NODE_KEEP_CHILDREN);
             //panel.getUndoManager().addEdit(undo);
             GroupTreeNode groupNode = group.getGroupNode();
-            groupNode.getParent().ifPresent(parent ->
-                    groupNode.moveAllChildrenTo(parent, parent.getIndexOfChild(groupNode).get()));
+            groupNode.getParent()
+                    .ifPresent(parent -> groupNode.moveAllChildrenTo(parent, parent.getIndexOfChild(groupNode).get()));
             groupNode.removeFromParent();
 
             dialogService.notify(Localization.lang("Removed group \"%0\".", group.getDisplayName()));
         }
     }
 
-
     /**
      * Removes the specified group and its subgroups (after asking for confirmation).
      */
@@ -249,4 +255,9 @@ public void removeSelectedEntries(GroupNodeViewModel group) {
         // if (!undo.isEmpty()) {
         //    mPanel.getUndoManager().addEdit(UndoableChangeEntriesOfGroup.getUndoableEdit(mNode, undo));
     }
+
+    public void sortAlphabeticallyRecursive(GroupNodeViewModel group) {
+        group.getGroupNode().sortChildren(compAlphabetIgnoreCase, true);
+
+    }
 }
diff --git a/src/main/java/org/jabref/gui/groups/GroupsTree.java b/src/main/java/org/jabref/gui/groups/GroupsTree.java
@@ -20,6 +20,7 @@ public GroupsTree(GroupSelector groupSelector) {
         getSelectionModel().setSelectionMode(
                 TreeSelectionModel.DISCONTIGUOUS_TREE_SELECTION);
         this.setFocusable(true);
+
     }
 
     /** Highlights the specified cell or disables highlight if cell == null */

diff --git a/src/main/java/org/jabref/model/groups/AbstractGroup.java b/src/main/java/org/jabref/model/groups/AbstractGroup.java
@@ -45,6 +45,24 @@ public String toString() {
                 '}';
     }
 
+    @Override
+    public boolean equals(Object other) {
+        if (this == other) {
+            return true;
+        }
+        if ((other == null) || (getClass() != other.getClass())) {
+            return false;
+        }
+        AbstractGroup that = (AbstractGroup) other;
+        return Objects.equals(this.name, that.name) && Objects.equals(this.description, that.description)
+                && Objects.equals(this.context, that.context);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(name, description, context);
+    }
+
     public Optional<Color> getColor() {
         return color;
     }

diff --git a/src/main/resources/l10n/JabRef_da.properties b/src/main/resources/l10n/JabRef_da.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=
 Color=
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=
 
+Sort_all_subgroups_(recursively)=
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=
 Don't_share=
 Share_anonymous_statistics=

diff --git a/src/main/resources/l10n/JabRef_de.properties b/src/main/resources/l10n/JabRef_de.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=Unterstriche_maskieren
 Color=
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=
 
+Sort_all_subgroups_(recursively)=
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=
 Don't_share=
 Share_anonymous_statistics=

diff --git a/src/main/resources/l10n/JabRef_en.properties b/src/main/resources/l10n/JabRef_en.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=Escape_underscores
 Color=Color
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.
 
+Sort_all_subgroups_(recursively)=Sort_all_subgroups_(recursively)
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=Collect_and_share_telemetry_data_to_help_improve_JabRef.
 Don't_share=Don't_share
 Share_anonymous_statistics=Share_anonymous_statistics

diff --git a/src/main/resources/l10n/JabRef_es.properties b/src/main/resources/l10n/JabRef_es.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=
 Color=
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=
 
+Sort_all_subgroups_(recursively)=
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=
 Don't_share=
 Share_anonymous_statistics=

diff --git a/src/main/resources/l10n/JabRef_fa.properties b/src/main/resources/l10n/JabRef_fa.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=
 Color=
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=
 
+Sort_all_subgroups_(recursively)=
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=
 Don't_share=
 Share_anonymous_statistics=

diff --git a/src/main/resources/l10n/JabRef_fr.properties b/src/main/resources/l10n/JabRef_fr.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=Echapper_les_soulignements
 Color=Couleur
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=S'il_vous_plaît,_Ajouter_si_possible_toutes_les_étapes_permettant_de_reproduire_cette_anomalie.
 
+Sort_all_subgroups_(recursively)=
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=
 Don't_share=
 Share_anonymous_statistics=

diff --git a/src/main/resources/l10n/JabRef_in.properties b/src/main/resources/l10n/JabRef_in.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=
 Color=
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=
 
+Sort_all_subgroups_(recursively)=
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=
 Don't_share=
 Share_anonymous_statistics=

diff --git a/src/main/resources/l10n/JabRef_it.properties b/src/main/resources/l10n/JabRef_it.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=
 Color=
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=
 
+Sort_all_subgroups_(recursively)=
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=
 Don't_share=
 Share_anonymous_statistics=

diff --git a/src/main/resources/l10n/JabRef_ja.properties b/src/main/resources/l10n/JabRef_ja.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=
 Color=
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=
 
+Sort_all_subgroups_(recursively)=
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=
 Don't_share=
 Share_anonymous_statistics=

diff --git a/src/main/resources/l10n/JabRef_nl.properties b/src/main/resources/l10n/JabRef_nl.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=
 Color=
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=
 
+Sort_all_subgroups_(recursively)=
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=
 Don't_share=
 Share_anonymous_statistics=

diff --git a/src/main/resources/l10n/JabRef_no.properties b/src/main/resources/l10n/JabRef_no.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=
 Color=
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=
 
+Sort_all_subgroups_(recursively)=
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=
 Don't_share=
 Share_anonymous_statistics=

diff --git a/src/main/resources/l10n/JabRef_pt_BR.properties b/src/main/resources/l10n/JabRef_pt_BR.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=
 Color=
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=
 
+Sort_all_subgroups_(recursively)=
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=
 Don't_share=
 Share_anonymous_statistics=

diff --git a/src/main/resources/l10n/JabRef_ru.properties b/src/main/resources/l10n/JabRef_ru.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=
 Color=
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=
 
+Sort_all_subgroups_(recursively)=
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=
 Don't_share=
 Share_anonymous_statistics=

diff --git a/src/main/resources/l10n/JabRef_sv.properties b/src/main/resources/l10n/JabRef_sv.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=Maskera_understreck
 Color=
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=
 
+Sort_all_subgroups_(recursively)=
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=
 Don't_share=
 Share_anonymous_statistics=

diff --git a/src/main/resources/l10n/JabRef_tr.properties b/src/main/resources/l10n/JabRef_tr.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=
 Color=
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=
 
+Sort_all_subgroups_(recursively)=
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=
 Don't_share=
 Share_anonymous_statistics=

diff --git a/src/main/resources/l10n/JabRef_vi.properties b/src/main/resources/l10n/JabRef_vi.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=
 Color=
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=
 
+Sort_all_subgroups_(recursively)=
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=
 Don't_share=
 Share_anonymous_statistics=

diff --git a/src/main/resources/l10n/JabRef_zh.properties b/src/main/resources/l10n/JabRef_zh.properties
@@ -2347,6 +2347,7 @@ Escape_underscores=
 Color=
 Please_also_add_all_steps_to_reproduce_this_issue,_if_possible.=
 
+Sort_all_subgroups_(recursively)=
 Collect_and_share_telemetry_data_to_help_improve_JabRef.=
 Don't_share=
 Share_anonymous_statistics=