Refactor Sidepane logic

src/main/java/org/jabref/gui/sidepane/GroupsSidePaneHeaderView.java

@@ -0,0 +1,59 @@
+package org.jabref.gui.sidepane;
+
+import javafx.scene.control.Button;
+
+import org.jabref.gui.DialogService;
+import org.jabref.gui.Globals;
+import org.jabref.gui.actions.ActionFactory;
+import org.jabref.gui.actions.SimpleCommand;
+import org.jabref.gui.groups.GroupModeViewModel;
+import org.jabref.gui.groups.GroupViewMode;
+import org.jabref.gui.icon.IconTheme;
+import org.jabref.logic.l10n.Localization;
+import org.jabref.preferences.PreferencesService;
+
+public class GroupsSidePaneHeaderView extends SidePaneHeaderView {
+ private final PreferencesService preferences;
+ private final DialogService dialogService;
+ private final Button intersectionUnionToggle = IconTheme.JabRefIcons.GROUP_INTERSECTION.asButton();
+
+ public GroupsSidePaneHeaderView(SidePaneType sidePaneType, SimpleCommand closeCommand, SimpleCommand moveUpCommand, SimpleCommand moveDownCommand, PreferencesService preferences, DialogService dialogService) {
+ super(sidePaneType, closeCommand, moveUpCommand, moveDownCommand);
+ this.preferences = preferences;
+ this.dialogService = dialogService;
+ setupIntersectionUnionToggle();
+ }
+
+ private void setupIntersectionUnionToggle() {
+ addButtonAtPosition(intersectionUnionToggle, 2);
+ ActionFactory factory = new ActionFactory(Globals.getKeyPrefs());
+ factory.configureIconButton(getSidePaneType().getToggleAction(), new ToggleUnionIntersectionAction(), intersectionUnionToggle);
+ }
+
+ public void afterOpening() {
+ setGraphicsAndTooltipForButton(preferences.getGroupViewMode());
+ }
+
+ private void setGraphicsAndTooltipForButton(GroupViewMode mode) {
+ GroupModeViewModel modeViewModel = new GroupModeViewModel(mode);
+ intersectionUnionToggle.setGraphic(modeViewModel.getUnionIntersectionGraphic());
+ intersectionUnionToggle.setTooltip(modeViewModel.getUnionIntersectionTooltip());
+ }
+
+ public class ToggleUnionIntersectionAction extends SimpleCommand {
+
+ @Override
+ public void execute() {
+ GroupViewMode mode = preferences.getGroupViewMode();
+
+ if (mode == GroupViewMode.UNION) {
+ preferences.setGroupViewMode(GroupViewMode.INTERSECTION);
+ dialogService.notify(Localization.lang("Group view mode set to intersection"));
+ } else if (mode == GroupViewMode.INTERSECTION) {
+ preferences.setGroupViewMode(GroupViewMode.UNION);
+ dialogService.notify(Localization.lang("Group view mode set to union"));
+ }
+ setGraphicsAndTooltipForButton(mode);
+ }
+ }
+}

src/main/java/org/jabref/gui/sidepane/GroupsSidePaneView.java

@@ -0,0 +1,17 @@
+package org.jabref.gui.sidepane;
+
+import javafx.scene.Node;
+import javafx.scene.layout.Priority;
+
+import org.jabref.gui.DialogService;
+import org.jabref.preferences.PreferencesService;
+
+public class GroupsSidePaneView extends SidePaneView {
+ public GroupsSidePaneView(GroupsSidePaneHeaderView sidePaneHeaderView, Node content, Priority resizePolicy, PreferencesService preferences, DialogService dialogService) {
+ super(sidePaneHeaderView, content, resizePolicy);
+ }
+
+ public void afterOpening() {
+ ((GroupsSidePaneHeaderView) (getSidePaneHeaderView())).afterOpening();
+ }
+}

src/main/java/org/jabref/gui/sidepane/SidePane.java

@@ -45,6 +45,7 @@ public SidePane(PreferencesService preferencesService,
  this.dialogService = dialogService;
  this.stateManager = stateManager;
  this.undoManager = undoManager;
+ initComponents();
 
  setId("sidePane");
 
@@ -53,7 +54,21 @@ public SidePane(PreferencesService preferencesService,
  updateView();
  }
 
+ private void initComponents() {
+ components.put(SidePaneType.GROUPS, new GroupSidePane(this, taskExecutor, stateManager, preferencesService, dialogService));
+ components.put(SidePaneType.OPEN_OFFICE, new OpenOfficeSidePanel(this, taskExecutor, preferencesService, dialogService, stateManager, undoManager));
+ components.put(SidePaneType.WEB_SEARCH, new WebSearchPane(this, preferencesService, dialogService, stateManager));
+ components.forEach((key, value) -> value.visibleProperty().addListener((x, y, isVisible) -> {
+ if (isVisible) {
+ show(key);
+ } else {
+ hide(key);
+ }
+ }));
+ }
+
  public boolean isComponentVisible(SidePaneType type) {
+ // TODO('return getComponent(type).visiblePropertyProperty().get();')
  return visibleComponents.contains(getComponent(type));
  }
 

src/main/java/org/jabref/gui/sidepane/SidePaneComponent.java

@@ -3,6 +3,8 @@
 import java.util.Collections;
 import java.util.List;
 
+import javafx.beans.property.BooleanProperty;
+import javafx.beans.property.SimpleBooleanProperty;
 import javafx.scene.Node;
 import javafx.scene.control.Button;
 import javafx.scene.control.Label;
@@ -24,6 +26,7 @@ public abstract class SidePaneComponent {
  private final JabRefIcon icon;
  private final String title;
  private Node contentNode;
+ private final BooleanProperty visible = new SimpleBooleanProperty();
 
  public SidePaneComponent(SidePane sidePane, JabRefIcon icon, String title) {
  this.sidePane = sidePane;
@@ -32,11 +35,25 @@ public SidePaneComponent(SidePane sidePane, JabRefIcon icon, String title) {
  this.toggleCommand = new ToggleCommand(this);
  }
 
+ public BooleanProperty visibleProperty() {
+ return visible;
+ }
+
+ public boolean isVisible() {
+ return visibleProperty().get();
+ }
+
+ // TODO ('hide() is only used in SidePane')
  protected void hide() {
+ visible.setValue(false);
+ // TODO('Model should not update the view directly')
  sidePane.hide(this.getType());
  }
 
+ // TODO ('show() is only used in SidePane')
  protected void show() {
+ visible.setValue(true);
+ // TODO('Model should not update the view directly')
  sidePane.show(this.getType());
  }
 
@@ -96,6 +113,7 @@ public final Node getContentPane() {
  public final Node getHeader() {
  Button close = IconTheme.JabRefIcons.CLOSE.asButton();
  close.setTooltip(new Tooltip(Localization.lang("Hide panel")));
+ // TODO (Use visibleProperty inside onAction)
  close.setOnAction(event -> hide());
 
  Button up = IconTheme.JabRefIcons.UP.asButton();

src/main/java/org/jabref/gui/sidepane/SidePaneContainerView.java

@@ -0,0 +1,109 @@
+package org.jabref.gui.sidepane;
+
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+import javax.swing.undo.UndoManager;
+
+import javafx.collections.FXCollections;
+import javafx.collections.ObservableList;
+import javafx.scene.layout.Priority;
+import javafx.scene.layout.VBox;
+
+import org.jabref.gui.DialogService;
+import org.jabref.gui.StateManager;
+import org.jabref.gui.actions.SimpleCommand;
+import org.jabref.gui.groups.GroupTreeView;
+import org.jabref.gui.util.TaskExecutor;
+import org.jabref.preferences.PreferencesService;
+
+public class SidePaneContainerView extends VBox {
+ private Map<SidePaneType, SidePaneView> sidePaneViewLookup;
+ // TODO('Use preferencesService.getSidePanePreferences().visiblePanes() as the single source of truth')
+ private final ObservableList<SidePaneType> visiblePanes = FXCollections.observableArrayList();
+
+ private final PreferencesService preferencesService;
+ private final TaskExecutor taskExecutor;
+ private final DialogService dialogService;
+ private final StateManager stateManager;
+ private final UndoManager undoManager;
+
+ public SidePaneContainerView(PreferencesService preferencesService,
+ TaskExecutor taskExecutor,
+ DialogService dialogService,
+ StateManager stateManager,
+ UndoManager undoManager) {
+ this.preferencesService = preferencesService;
+ this.taskExecutor = taskExecutor;
+ this.dialogService = dialogService;
+ this.stateManager = stateManager;
+ this.undoManager = undoManager;
+ initSidePanes();
+ }
+
+ private void initSidePanes() {
+ SidePaneView groupsPaneView = createGroupsPaneView();
+ }
+
+ private SidePaneView createGroupsPaneView() {
+ GroupsSidePaneHeaderView groupsHeader = new GroupsSidePaneHeaderView(SidePaneType.GROUPS,
+ new CloseSidePaneAction(SidePaneType.GROUPS), null, null, preferencesService, dialogService);
+ GroupTreeView groupsContent = new GroupTreeView(taskExecutor, stateManager, preferencesService, dialogService);
+
+ return new GroupsSidePaneView(groupsHeader, groupsContent, Priority.ALWAYS, preferencesService, dialogService);
+ }
+
+ private void showSidePanes(Set<SidePaneType> toShowSidePanes) {
+ getChildren().clear();
+ toShowSidePanes.forEach(type -> {
+ SidePaneView view = sidePaneViewLookup.get(type);
+ getChildren().add(view);
+ VBox.setVgrow(view, view.getResizePolicy());
+ });
+ }
+
+ private void show(SidePaneType paneType) {
+ if (!visiblePanes.contains(paneType)) {
+ visiblePanes.add(paneType);
+ preferencesService.getSidePanePreferences().visiblePanes().add(paneType);
+ // TODO('Sort')
+ updateView();
+ }
+ }
+
+ private void hide(SidePaneType paneType) {
+ if (visiblePanes.contains(paneType)) {
+ // TODO('Before closing')
+ visiblePanes.remove(paneType);
+ preferencesService.getSidePanePreferences().visiblePanes().remove(paneType);
+ updateView();
+ }
+ }
+
+ private void moveUp(SidePaneType type) {
+
+ }
+
+ public ObservableList<SidePaneType> getVisiblePanes() {
+ return visiblePanes;
+ }
+
+ private void updateView() {
+ showSidePanes(new HashSet<>(visiblePanes));
+ setVisible(!visiblePanes.isEmpty());
+ }
+
+ private class CloseSidePaneAction extends SimpleCommand {
+ private final SidePaneType toClosePaneType;
+
+ public CloseSidePaneAction(SidePaneType toClosePaneType) {
+ this.toClosePaneType = toClosePaneType;
+ }
+
+ @Override
+ public void execute() {
+ hide(toClosePaneType);
+ }
+ }
+}

src/main/java/org/jabref/gui/sidepane/SidePaneContainerViewModel.java

@@ -0,0 +1,22 @@
+package org.jabref.gui.sidepane;
+
+import org.jabref.gui.AbstractViewModel;
+
+public class SidePaneContainerViewModel extends AbstractViewModel {
+
+ public void moveUp(SidePaneType sidePaneType) {
+
+ }
+
+ public void moveDown(SidePaneType sidePaneType) {
+
+ }
+
+ public void show(SidePaneType sidePaneType) {
+
+ }
+
+ public void hide(SidePaneType sidePaneType) {
+
+ }
+}

src/main/java/org/jabref/gui/sidepane/SidePaneHeaderView.java

@@ -0,0 +1,61 @@
+package org.jabref.gui.sidepane;
+
+import javafx.scene.control.Button;
+import javafx.scene.control.Label;
+import javafx.scene.control.Tooltip;
+import javafx.scene.layout.BorderPane;
+import javafx.scene.layout.HBox;
+
+import org.jabref.gui.Globals;
+import org.jabref.gui.actions.ActionFactory;
+import org.jabref.gui.actions.SimpleCommand;
+import org.jabref.gui.icon.IconTheme;
+import org.jabref.logic.l10n.Localization;
+
+public class SidePaneHeaderView extends BorderPane {
+ private final SidePaneType sidePaneType;
+ private final SimpleCommand closeCommand;
+ private final SimpleCommand moveUpCommand;
+ private final SimpleCommand moveDownCommand;
+
+ private HBox buttonContainer;
+
+ public SidePaneHeaderView(SidePaneType sidePaneType, SimpleCommand closeCommand, SimpleCommand moveUpCommand, SimpleCommand moveDownCommand) {
+ this.sidePaneType = sidePaneType;
+ this.closeCommand = closeCommand;
+ this.moveUpCommand = moveUpCommand;
+ this.moveDownCommand = moveDownCommand;
+ initView();
+ }
+
+ private void initView() {
+ ActionFactory factory = new ActionFactory(Globals.getKeyPrefs());
+ Button closeButton = IconTheme.JabRefIcons.CLOSE.asButton();
+ closeButton.setTooltip(new Tooltip(Localization.lang("Hide panel")));
+ factory.configureIconButton(sidePaneType.getToggleAction(), closeCommand, closeButton);
+
+ Button upButton = IconTheme.JabRefIcons.UP.asButton();
+ upButton.setTooltip(new Tooltip(Localization.lang("Move panel up")));
+ factory.configureIconButton(sidePaneType.getToggleAction(), moveUpCommand, upButton);
+
+ Button downButton = IconTheme.JabRefIcons.DOWN.asButton();
+ downButton.setTooltip(new Tooltip(Localization.lang("Move panel down")));
+ factory.configureIconButton(sidePaneType.getToggleAction(), moveDownCommand, downButton);
+
+ this.buttonContainer = new HBox();
+ buttonContainer.getChildren().addAll(upButton, downButton, closeButton);
+
+ Label label = new Label(sidePaneType.getTitle());
+ setCenter(label);
+ setRight(buttonContainer);
+ getStyleClass().add("sidePaneComponentHeader");
+ }
+
+ protected void addButtonAtPosition(Button button, int position) {
+ this.buttonContainer.getChildren().set(position, button);
+ }
+
+ public SidePaneType getSidePaneType() {
+ return sidePaneType;
+ }
+}

src/main/java/org/jabref/gui/sidepane/SidePaneType.java

@@ -1,10 +1,36 @@
 package org.jabref.gui.sidepane;
 
+import org.jabref.gui.actions.Action;
+import org.jabref.gui.actions.StandardActions;
+import org.jabref.gui.icon.JabRefIcon;
+
 /**
  * Definition of all possible components in the side pane.
  */
 public enum SidePaneType {
- OPEN_OFFICE,
- WEB_SEARCH,
- GROUPS
+ OPEN_OFFICE("", null, StandardActions.TOOGLE_OO),
+ WEB_SEARCH("", null, StandardActions.TOGGLE_WEB_SEARCH),
+ GROUPS("", null, StandardActions.TOGGLE_GROUPS);
+
+ private final String title;
+ private final JabRefIcon icon;
+ private final Action toggleAction;
+
+ SidePaneType(String title, JabRefIcon icon, Action toggleAction) {
+ this.title = title;
+ this.icon = icon;
+ this.toggleAction = toggleAction;
+ }
+
+ public String getTitle() {
+ return title;
+ }
+
+ public JabRefIcon getIcon() {
+ return icon;
+ }
+
+ public Action getToggleAction() {
+ return toggleAction;
+ }
 }