Right click create group

CHANGELOG.md

@@ -11,6 +11,8 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 
 ### Added
 
+- We added the ability to add the current selection to a newly created group. [#11449](https://github.com/JabRef/jabref/issues/11449)
+
 ### Changed
 
 ### Fixed

src/main/java/module-info.java

@@ -46,7 +46,7 @@
  requires org.tinylog.impl;
 
  provides org.tinylog.writers.Writer
- with org.jabref.gui.logging.GuiWriter;
+  with org.jabref.gui.logging.GuiWriter;
 
  // Preferences and XML
  requires java.prefs;

src/main/java/org/jabref/gui/StateManager.java

@@ -75,7 +75,12 @@ public class StateManager {
  private final ObservableList<String> searchHistory = FXCollections.observableArrayList();
 
  public StateManager() {
- activeGroups.bind(Bindings.valueAt(selectedGroups, activeDatabase.orElseOpt(null).map(BibDatabaseContext::getUid)));
+ activeGroups.bind(Bindings.valueAt(
+ selectedGroups,
+ activeDatabase
+ .orElseOpt(null)
+ .map(BibDatabaseContext::getUid))
+ .orElse(FXCollections.observableArrayList()));
  }
 
  public ObservableList<SidePaneType> getVisibleSidePaneComponents() {
@@ -161,6 +166,7 @@ public void setActiveDatabase(BibDatabaseContext database) {
  LOGGER.info("No open database detected");
  activeDatabaseProperty().set(Optional.empty());
  } else {
+ selectedGroups.computeIfAbsent(database.getUid(), k -> FXCollections.emptyObservableList());
  activeDatabaseProperty().set(Optional.of(database));
  }
  }

src/main/java/org/jabref/gui/actions/StandardActions.java

@@ -36,6 +36,7 @@ public enum StandardActions implements Action {
  EXTRACT_FILE_REFERENCES_OFFLINE(Localization.lang("Extract references from file (offline)"), IconTheme.JabRefIcons.FILE_STAR),
  OPEN_URL(Localization.lang("Open URL or DOI"), IconTheme.JabRefIcons.WWW, KeyBinding.OPEN_URL_OR_DOI),
  SEARCH_SHORTSCIENCE(Localization.lang("Search ShortScience")),
+ ADD_SUBGROUP_FROM_SELECTION(Localization.lang("Add subgroup from selection")),
  MERGE_WITH_FETCHED_ENTRY(Localization.lang("Get bibliographic data from %0", "DOI/ISBN/...")),
  ATTACH_FILE(Localization.lang("Attach file"), IconTheme.JabRefIcons.ATTACH_FILE),
  ATTACH_FILE_FROM_URL(Localization.lang("Attach file from URL"), IconTheme.JabRefIcons.DOWNLOAD_FILE),

src/main/java/org/jabref/gui/exporter/ExportCommand.java

@@ -2,12 +2,12 @@
 
 import java.io.IOException;
 import java.nio.file.Path;
-import java.util.Collections;
 import java.util.Comparator;
 import java.util.List;
 import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
+import javafx.collections.FXCollections;
 import javafx.stage.FileChooser;
 import javafx.util.Duration;
 
@@ -111,7 +111,7 @@ private void export(Path file, FileChooser.ExtensionFilter selectedExtensionFilt
  // All entries
  entries = stateManager.getActiveDatabase()
  .map(BibDatabaseContext::getEntries)
- .orElse(Collections.emptyList());
+ .orElse(FXCollections.emptyObservableList());
  }
 
  List<Path> fileDirForDatabase = stateManager.getActiveDatabase()

src/main/java/org/jabref/gui/groups/GroupDialog.fxml

@@ -102,6 +102,9 @@
  </VBox>
  <Separator orientation="VERTICAL"/>
  <StackPane HBox.hgrow="ALWAYS">
+ <VBox visible="${explicitRadioButton.selected}" spacing="10.0">
+ <CheckBox fx:id="explicitIncludeSelected" text="%Include selected entries in new subgroup"/>
+ </VBox>
  <VBox visible="${keywordsRadioButton.selected}" spacing="10.0">
  <VBox>
  <Label text="%Field"/>

src/main/java/org/jabref/gui/groups/GroupDialogView.java

@@ -35,12 +35,14 @@
 import org.jabref.gui.help.HelpAction;
 import org.jabref.gui.icon.IconTheme;
 import org.jabref.gui.icon.JabrefIconProvider;
+import org.jabref.gui.maintable.Selection;
 import org.jabref.gui.util.BaseDialog;
 import org.jabref.gui.util.IconValidationDecorator;
 import org.jabref.gui.util.ViewModelListCellFactory;
 import org.jabref.logic.help.HelpFile;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.entry.BibEntry;
 import org.jabref.model.groups.AbstractGroup;
 import org.jabref.model.groups.GroupHierarchyType;
 import org.jabref.model.groups.GroupTreeNode;
@@ -83,6 +85,8 @@ public class GroupDialogView extends BaseDialog<AbstractGroup> {
  @FXML private RadioButton texRadioButton;
 
  // Option Groups
+ @FXML private CheckBox explicitIncludeSelected;
+
  @FXML private TextField keywordGroupSearchTerm;
  @FXML private TextField keywordGroupSearchField;
  @FXML private CheckBox keywordGroupCaseSensitive;
@@ -109,6 +113,8 @@ public class GroupDialogView extends BaseDialog<AbstractGroup> {
  private final BibDatabaseContext currentDatabase;
  private final @Nullable GroupTreeNode parentNode;
  private final @Nullable AbstractGroup editedGroup;
+ private final List<BibEntry> selectedEntries;
+ private final Selection includeSelectedEntries;
 
  private GroupDialogViewModel viewModel;
 
@@ -119,10 +125,15 @@ public class GroupDialogView extends BaseDialog<AbstractGroup> {
  public GroupDialogView(BibDatabaseContext currentDatabase,
  @Nullable GroupTreeNode parentNode,
  @Nullable AbstractGroup editedGroup,
- GroupDialogHeader groupDialogHeader) {
+ GroupDialogHeader groupDialogHeader,
+ List<BibEntry> selectedEntries,
+ Selection includeSelectedEntries
+ ) {
  this.currentDatabase = currentDatabase;
  this.parentNode = parentNode;
  this.editedGroup = editedGroup;
+ this.selectedEntries = selectedEntries;
+ this.includeSelectedEntries = includeSelectedEntries;
 
  ViewLoader.view(this)
  .load()
@@ -172,7 +183,7 @@ public GroupDialogView(BibDatabaseContext currentDatabase,
 
  @FXML
  public void initialize() {
- viewModel = new GroupDialogViewModel(dialogService, currentDatabase, preferencesService, editedGroup, parentNode, fileUpdateMonitor);
+ viewModel = new GroupDialogViewModel(dialogService, currentDatabase, preferencesService, editedGroup, parentNode, fileUpdateMonitor, selectedEntries, includeSelectedEntries);
 
  setResultConverter(viewModel::resultConverter);
 
@@ -201,6 +212,8 @@ public void initialize() {
  autoRadioButton.selectedProperty().bindBidirectional(viewModel.typeAutoProperty());
  texRadioButton.selectedProperty().bindBidirectional(viewModel.typeTexProperty());
 
+ explicitIncludeSelected.selectedProperty().bindBidirectional(viewModel.explicitIncludeSelectedProperty());
+
  keywordGroupSearchTerm.textProperty().bindBidirectional(viewModel.keywordGroupSearchTermProperty());
  keywordGroupSearchField.textProperty().bindBidirectional(viewModel.keywordGroupSearchFieldProperty());
  keywordGroupCaseSensitive.selectedProperty().bindBidirectional(viewModel.keywordGroupCaseSensitiveProperty());
@@ -247,7 +260,7 @@ public void initialize() {
  validationVisualizer.initVisualization(viewModel.keywordRegexValidationStatus(), keywordGroupSearchTerm);
  validationVisualizer.initVisualization(viewModel.keywordSearchTermEmptyValidationStatus(), keywordGroupSearchTerm);
  validationVisualizer.initVisualization(viewModel.keywordFieldEmptyValidationStatus(), keywordGroupSearchField);
- validationVisualizer.initVisualization(viewModel.texGroupFilePathValidatonStatus(), texGroupFilePath);
+ validationVisualizer.initVisualization(viewModel.texGroupFilePathValidationStatus(), texGroupFilePath);
  nameField.requestFocus();
  });
 
@@ -261,10 +274,14 @@ public void initialize() {
  viewModel.colorFieldProperty().setValue(IconTheme.getDefaultGroupColor());
  return;
  }
- List<Color> colorsOfSiblings = parentNode.getChildren().stream().map(child -> child.getGroup().getColor())
- .flatMap(Optional::stream)
- .toList();
- Optional<Color> parentColor = parentGroup().getColor();
+
+ List<Color> colorsOfSiblings = parentNode.getChildren()
+ .stream()
+ .map(GroupTreeNode::getGroup)
+ .map(AbstractGroup::getColor)
+ .flatMap(Optional::stream)
+ .toList();
+ Optional<Color> parentColor = parentNode.getGroup().getColor();
  Color color;
  color = parentColor.map(value -> GroupColorPicker.generateColor(colorsOfSiblings, value)).orElseGet(() -> GroupColorPicker.generateColor(colorsOfSiblings));
  viewModel.colorFieldProperty().setValue(color);

src/main/java/org/jabref/gui/groups/GroupDialogViewModel.java

@@ -25,6 +25,7 @@
 
 import org.jabref.gui.DialogService;
 import org.jabref.gui.icon.IconTheme;
+import org.jabref.gui.maintable.Selection;
 import org.jabref.gui.util.FileDialogConfiguration;
 import org.jabref.logic.auxparser.DefaultAuxParser;
 import org.jabref.logic.groups.DefaultGroupsFactory;
@@ -33,6 +34,7 @@
 import org.jabref.logic.util.io.FileUtil;
 import org.jabref.model.database.BibDatabase;
 import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.model.entry.BibEntry;
 import org.jabref.model.entry.Keyword;
 import org.jabref.model.entry.field.FieldFactory;
 import org.jabref.model.groups.AbstractGroup;
@@ -77,12 +79,15 @@ public class GroupDialogViewModel {
  private final BooleanProperty typeAutoProperty = new SimpleBooleanProperty();
  private final BooleanProperty typeTexProperty = new SimpleBooleanProperty();
 
+ // Explicit Groups
+ private final BooleanProperty explicitIncludeSelectedProperty = new SimpleBooleanProperty(false);
+
  // Option Groups
  private final StringProperty keywordGroupSearchTermProperty = new SimpleStringProperty("");
  private final StringProperty keywordGroupSearchFieldProperty = new SimpleStringProperty("");
  private final BooleanProperty keywordGroupCaseSensitiveProperty = new SimpleBooleanProperty();
  private final BooleanProperty keywordGroupRegexProperty = new SimpleBooleanProperty();
-
+ 
  private final StringProperty searchGroupSearchTermProperty = new SimpleStringProperty("");
  private final ObjectProperty<EnumSet<SearchFlags>> searchFlagsProperty = new SimpleObjectProperty<>(EnumSet.noneOf(SearchFlags.class));
 
@@ -112,24 +117,42 @@ public class GroupDialogViewModel {
  private final AbstractGroup editedGroup;
  private final GroupTreeNode parentNode;
  private final FileUpdateMonitor fileUpdateMonitor;
+ private final List<BibEntry> selectedEntries;
+ private final Selection includeSelectedEntries;
 
  public GroupDialogViewModel(DialogService dialogService,
  BibDatabaseContext currentDatabase,
  PreferencesService preferencesService,
  @Nullable AbstractGroup editedGroup,
  @Nullable GroupTreeNode parentNode,
- FileUpdateMonitor fileUpdateMonitor) {
+ FileUpdateMonitor fileUpdateMonitor,
+ List<BibEntry> selectedEntries,
+ Selection includeSelectedEntries
+ ) {
  this.dialogService = dialogService;
  this.preferencesService = preferencesService;
  this.currentDatabase = currentDatabase;
  this.editedGroup = editedGroup;
  this.parentNode = parentNode;
  this.fileUpdateMonitor = fileUpdateMonitor;
+ this.selectedEntries = selectedEntries;
+ this.includeSelectedEntries = includeSelectedEntries;
 
  setupValidation();
  setValues();
  }
 
+ public GroupDialogViewModel(
+ DialogService dialogService,
+ BibDatabaseContext currentDatabase,
+ PreferencesService preferencesService,
+ @Nullable AbstractGroup editedGroup,
+ @Nullable GroupTreeNode parentNode,
+ FileUpdateMonitor fileUpdateMonitor
+ ) {
+ this(dialogService, currentDatabase, preferencesService, editedGroup, parentNode, fileUpdateMonitor, new ArrayList<>(), Selection.IGNORE_SELECTED_ENTRIES);
+ }
+
  private void setupValidation() {
  validator = new CompositeValidator();
 
@@ -246,7 +269,7 @@ private void setupValidation() {
  return false;
  }
  return FileUtil.getFileExtension(input)
- .map(extension -> "aux".equalsIgnoreCase(extension))
+ .map("aux"::equalsIgnoreCase)
  .orElse(false);
  }
  },
@@ -310,10 +333,15 @@ public AbstractGroup resultConverter(ButtonType button) {
  try {
  String groupName = nameProperty.getValue().trim();
  if (typeExplicitProperty.getValue()) {
- resultingGroup = new ExplicitGroup(
+ ExplicitGroup tempResultingGroup = new ExplicitGroup(
  groupName,
  groupHierarchySelectedProperty.getValue(),
- preferencesService.getBibEntryPreferences().getKeywordSeparator());
+ preferencesService.getBibEntryPreferences().getKeywordSeparator()
+ );
+ if (explicitIncludeSelectedProperty.getValue()) {
+ tempResultingGroup.add(selectedEntries);
+ }
+ resultingGroup = tempResultingGroup;
  } else if (typeKeywordsProperty.getValue()) {
  if (keywordGroupRegexProperty.getValue()) {
  resultingGroup = new RegexKeywordGroup(
@@ -372,7 +400,6 @@ public AbstractGroup resultConverter(ButtonType button) {
  fileUpdateMonitor,
  currentDatabase.getMetaData());
  }
-
  if (resultingGroup != null) {
  preferencesService.getGroupsPreferences().setDefaultHierarchicalContext(groupHierarchySelectedProperty.getValue());
 
@@ -391,7 +418,7 @@ public AbstractGroup resultConverter(ButtonType button) {
 
  public void setValues() {
  groupHierarchyListProperty.setValue(FXCollections.observableArrayList(GroupHierarchyType.values()));
-
+ explicitIncludeSelectedProperty.setValue(includeSelectedEntries == Selection.INCLUDE_SELECTED_ENTRIES || preferencesService.getGroupsPreferences().shouldAutoIncludeSelected());
  if (editedGroup == null) {
  // creating new group -> defaults!
  // TODO: Create default group (via org.jabref.logic.groups.DefaultGroupsFactory) and use values
@@ -492,7 +519,7 @@ public void texGroupBrowse() {
  }
 
  private List<Path> getFileDirectoriesAsPaths() {
- List<Path> fileDirs = new ArrayList<>();
+ List<Path> fileDirs = List.of();
  MetaData metaData = currentDatabase.getMetaData();
  metaData.getLatexFileDirectory(preferencesService.getFilePreferences().getUserAndHost()).ifPresent(fileDirs::add);
 
@@ -535,7 +562,7 @@ public ValidationStatus keywordSearchTermEmptyValidationStatus() {
  return keywordSearchTermEmptyValidator.getValidationStatus();
  }
 
- public ValidationStatus texGroupFilePathValidatonStatus() {
+ public ValidationStatus texGroupFilePathValidationStatus() {
  return texGroupFilePathValidator.getValidationStatus();
  }
 
@@ -587,6 +614,10 @@ public BooleanProperty typeTexProperty() {
  return typeTexProperty;
  }
 
+ public BooleanProperty explicitIncludeSelectedProperty() {
+ return explicitIncludeSelectedProperty;
+ }
+
  public StringProperty keywordGroupSearchTermProperty() {
  return keywordGroupSearchTermProperty;
  }