Refactor Sidepane logic

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

@@ -25,6 +25,7 @@
 import javafx.scene.control.Button;
 import javafx.scene.control.ButtonBar;
 import javafx.scene.control.ButtonType;
+import javafx.scene.control.CheckMenuItem;
 import javafx.scene.control.ContextMenu;
 import javafx.scene.control.Menu;
 import javafx.scene.control.MenuBar;
@@ -113,6 +114,7 @@
 import org.jabref.gui.shared.PullChangesFromSharedAction;
 import org.jabref.gui.sidepane.SidePane;
 import org.jabref.gui.sidepane.SidePaneComponent;
+import org.jabref.gui.sidepane.SidePaneContainerView;
 import org.jabref.gui.sidepane.SidePaneType;
 import org.jabref.gui.slr.ExistingStudySearchAction;
 import org.jabref.gui.slr.StartNewStudyAction;
@@ -145,6 +147,7 @@
 import com.google.common.eventbus.Subscribe;
 import com.tobiasdiez.easybind.EasyBind;
 import com.tobiasdiez.easybind.EasyObservableList;
+import de.saxsys.mvvmfx.utils.commands.Command;
 import org.controlsfx.control.PopOver;
 import org.controlsfx.control.TaskProgressView;
 import org.fxmisc.richtext.CodeArea;
@@ -343,7 +346,7 @@ public void about() {
  * FIXME: Currently some threads remain and therefore hinder JabRef to be closed properly
  *
  * @param filenames the filenames of all currently opened files - used for storing them if prefs openLastEdited is
- *  set to true
+ * set to true
  */
  private void tearDownJabRef(List<String> filenames) {
  if (prefs.getGuiPreferences().shouldOpenLastEdited()) {
@@ -941,6 +944,12 @@ private Button createNewEntryFromIdButton() {
  return newEntryFromIdButton;
  }
 
+ private CheckMenuItem createSidePaneCheckMenuItem(SidePaneContainerView container, ActionFactory factory, SidePaneType paneType, Command toggleCommand) {
+ CheckMenuItem checkMenuItem = factory.createCheckMenuItem(paneType.getToggleAction(), toggleCommand, (container.isPaneVisibleProperty(paneType).get()));
+ checkMenuItem.selectedProperty().bindBidirectional(container.isPaneVisibleProperty(paneType));
+ return checkMenuItem;
+ }
+
  private Group createTaskIndicator() {
  ProgressIndicator indicator = new ProgressIndicator();
  indicator.getStyleClass().add("progress-indicatorToolbar");
@@ -1108,7 +1117,7 @@ private boolean readyForAutosave(BibDatabaseContext context) {
  /**
  * Opens the import inspection dialog to let the user decide which of the given entries to import.
  *
- * @param panel  The BasePanel to add to.
+ * @param panel The BasePanel to add to.
  * @param parserResult The entries to add.
  */
  private void addImportedEntries(final LibraryTab panel, final ParserResult parserResult) {
@@ -1241,7 +1250,7 @@ public CloseDatabaseAction(LibraryTab libraryTab) {
 
  /**
  * Using this constructor will result in executing the command on the currently open library tab
- * */
+ */
  public CloseDatabaseAction() {
  this(null);
  }

src/main/java/org/jabref/gui/importer/fetcher/WebSearchPaneView.java

@@ -0,0 +1,95 @@
+package org.jabref.gui.importer.fetcher;
+
+import javafx.css.PseudoClass;
+import javafx.geometry.Pos;
+import javafx.scene.control.Button;
+import javafx.scene.control.ComboBox;
+import javafx.scene.control.TextField;
+import javafx.scene.control.Tooltip;
+import javafx.scene.input.KeyCode;
+import javafx.scene.layout.HBox;
+import javafx.scene.layout.Priority;
+import javafx.scene.layout.StackPane;
+import javafx.scene.layout.VBox;
+
+import org.jabref.gui.DialogService;
+import org.jabref.gui.StateManager;
+import org.jabref.gui.actions.ActionFactory;
+import org.jabref.gui.actions.StandardActions;
+import org.jabref.gui.help.HelpAction;
+import org.jabref.gui.search.SearchTextField;
+import org.jabref.gui.util.ViewModelListCellFactory;
+import org.jabref.logic.importer.SearchBasedFetcher;
+import org.jabref.logic.l10n.Localization;
+import org.jabref.preferences.PreferencesService;
+
+import com.tobiasdiez.easybind.EasyBind;
+
+public class WebSearchPaneView extends VBox {
+
+ private static final PseudoClass QUERY_INVALID = PseudoClass.getPseudoClass("invalid");
+
+ private final WebSearchPaneViewModel viewModel;
+ private final PreferencesService preferences;
+
+ public WebSearchPaneView(PreferencesService preferences, DialogService dialogService, StateManager stateManager) {
+ this.preferences = preferences;
+ this.viewModel = new WebSearchPaneViewModel(preferences, dialogService, stateManager);
+ initView();
+ }
+
+ private void initView() {
+ ComboBox<SearchBasedFetcher> fetchers = new ComboBox<>();
+ new ViewModelListCellFactory<SearchBasedFetcher>()
+ .withText(SearchBasedFetcher::getName)
+ .install(fetchers);
+ fetchers.itemsProperty().bind(viewModel.fetchersProperty());
+ fetchers.valueProperty().bindBidirectional(viewModel.selectedFetcherProperty());
+ fetchers.setMaxWidth(Double.POSITIVE_INFINITY);
+
+ // Create help button for currently selected fetcher
+ StackPane helpButtonContainer = new StackPane();
+ ActionFactory factory = new ActionFactory(preferences.getKeyBindingRepository());
+ EasyBind.subscribe(viewModel.selectedFetcherProperty(), fetcher -> {
+ if ((fetcher != null) && fetcher.getHelpPage().isPresent()) {
+ Button helpButton = factory.createIconButton(StandardActions.HELP, new HelpAction(fetcher.getHelpPage().get()));
+ helpButtonContainer.getChildren().setAll(helpButton);
+ } else {
+ helpButtonContainer.getChildren().clear();
+ }
+ });
+ HBox fetcherContainer = new HBox(fetchers, helpButtonContainer);
+ HBox.setHgrow(fetchers, Priority.ALWAYS);
+
+ // Create text field for query input
+ TextField query = SearchTextField.create();
+ query.getStyleClass().add("searchBar");
+
+ viewModel.queryProperty().bind(query.textProperty());
+ EasyBind.subscribe(viewModel.queryValidationStatus().validProperty(),
+ valid -> {
+ if (!valid && viewModel.queryValidationStatus().getHighestMessage().isPresent()) {
+ query.setTooltip(new Tooltip(viewModel.queryValidationStatus().getHighestMessage().get().getMessage()));
+ query.pseudoClassStateChanged(QUERY_INVALID, true);
+ } else {
+ query.setTooltip(null);
+ query.pseudoClassStateChanged(QUERY_INVALID, false);
+ }
+ });
+
+ // Allows triggering search on pressing enter
+ query.setOnKeyPressed(event -> {
+ if (event.getCode() == KeyCode.ENTER) {
+ viewModel.search();
+ }
+ });
+
+ // Create button that triggers search
+ Button search = new Button(Localization.lang("Search"));
+ search.setDefaultButton(false);
+ search.setOnAction(event -> viewModel.search());
+
+ setAlignment(Pos.CENTER);
+ getChildren().addAll(fetcherContainer, query, search);
+ }
+}

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

@@ -45,7 +45,6 @@ public SidePane(PreferencesService preferencesService,
  this.dialogService = dialogService;
  this.stateManager = stateManager;
  this.undoManager = undoManager;
- initComponents();
 
  setId("sidePane");
 
@@ -54,21 +53,7 @@ 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));
  }