Ticket #15167: merge-download-dialog-v5.patch

src/org/openstreetmap/josm/gui/download/AbstractDownloadSourcePanel.java

@@ -97 +97 @@
     public void triggerDownload(DownloadSettings downloadSettings) {
         getDownloadSource().doDownload(getData(), downloadSettings);
     }
+
+    /**
+     * Returns a simple name describing this panel. This string can be used from other GUI parts
+     * of JOSM to save the user preferences related to the GUI settings. For example, the panel for downloading
+     * the OSM data can be named 'downloadosmpanel'. Note, choose the name such that it is unique to avoid
+     * collisions with other names.
+     * @return A simple name describing this panel.
+     */
+    public abstract String getSimpleName();
 }

src/org/openstreetmap/josm/gui/download/DownloadDialog.java

@@ -15 +15 @@
 import java.awt.event.KeyEvent;
 import java.awt.event.WindowAdapter;
 import java.awt.event.WindowEvent;
+import java.beans.PropertyChangeListener;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -32 +33 @@
 import javax.swing.JSplitPane;
 import javax.swing.JTabbedPane;
 import javax.swing.KeyStroke;
+import javax.swing.event.ChangeEvent;
+import javax.swing.event.ChangeListener;
 
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.actions.ExpertToggleAction;
@@ -49 +52 @@
 import org.openstreetmap.josm.tools.GBC;
 import org.openstreetmap.josm.tools.ImageProvider;
 import org.openstreetmap.josm.tools.InputMapUtils;
+import org.openstreetmap.josm.tools.JosmRuntimeException;
 import org.openstreetmap.josm.tools.Logging;
 import org.openstreetmap.josm.tools.OsmUrlToBounds;
 import org.openstreetmap.josm.tools.WindowGeometry;
@@ -61 +65 @@
     /**
      * Preference properties
      */
+    private static final String TAB_SPLIT_NAMESPACE = "download.tabsplit.";
     private static final IntegerProperty DOWNLOAD_TAB = new IntegerProperty("download.tab", 0);
     private static final IntegerProperty DOWNLOAD_SOURCE_TAB = new IntegerProperty("download-source.tab", 0);
-    private static final IntegerProperty DIALOG_SPLIT = new IntegerProperty("download.split", 200);
     private static final BooleanProperty DOWNLOAD_AUTORUN = new BooleanProperty("download.autorun", false);
     private static final BooleanProperty DOWNLOAD_NEWLAYER = new BooleanProperty("download.newlayer", false);
     private static final BooleanProperty DOWNLOAD_ZOOMTODATA = new BooleanProperty("download.zoomtodata", true);
@@ -114 +118 @@
     protected final JPanel buildMainPanel() {
         mainPanel = new JPanel(new GridBagLayout());
 
-        downloadSources.add(new OSMDownloadSource());
-        downloadSources.add(new OverpassDownloadSource());
+        // add default download sources
+        addDownloadSource(new OSMDownloadSource());
+        addDownloadSource(new OverpassDownloadSource());
 
-        // register all default download sources
-        for (int i = 0; i < downloadSources.size(); i++) {
-            downloadSources.get(i).addGui(this);
-        }
-
         // must be created before hook
         slippyMapChooser = new SlippyMapChooser();
 
@@ -140 +140 @@
             s.addGui(this);
         }
 
-        // allow to collapse the panes completely
-        downloadSourcesTab.setMinimumSize(new Dimension(0, 0));
+        // allow to collapse the panes, but reserve some space for tabs
+        downloadSourcesTab.setMinimumSize(new Dimension(0, 25));
         tpDownloadAreaSelectors.setMinimumSize(new Dimension(0, 0));
 
         dialogSplit = new JSplitPane(
@@ -148 +148 @@
                 JSplitPane.VERTICAL_SPLIT,
                 downloadSourcesTab,
                 tpDownloadAreaSelectors);
+        dialogSplit.addPropertyChangeListener(getDividerChangedListener());
 
+        ChangeListener tabChangedListener = getDownloadSourceTabChangeListener();
+        tabChangedListener.stateChanged(new ChangeEvent(downloadSourcesTab));
+        downloadSourcesTab.addChangeListener(tabChangedListener);
+
         mainPanel.add(dialogSplit, GBC.eol().fill());
 
         cbNewLayer = new JCheckBox(tr("Download as new layer"));
@@ -170 +175 @@
 
         ExpertToggleAction.addVisibilitySwitcher(cbZoomToDownloadedData);
 
-        if (!ExpertToggleAction.isExpert()) {
-            JLabel infoLabel = new JLabel(
-                    tr("Use left click&drag to select area, arrows or right mouse button to scroll map, wheel or +/- to zoom."));
-            mainPanel.add(infoLabel, GBC.eol().anchor(GBC.SOUTH).insets(0, 0, 0, 0));
-        }
+        mainPanel.add(new JLabel(), GBC.eol()); // place info label at a new line
+        JLabel infoLabel = new JLabel(
+                tr("Use left click&drag to select area, arrows or right mouse button to scroll map, wheel or +/- to zoom."));
+        mainPanel.add(infoLabel, GBC.eol().anchor(GBC.CENTER).insets(0, 0, 0, 0));
+
+        ExpertToggleAction.addExpertModeChangeListener(isExpert -> infoLabel.setVisible(!isExpert), true);
+
         return mainPanel;
     }
 
@@ -252 +259 @@
         addWindowListener(new WindowEventHandler());
         ExpertToggleAction.addExpertModeChangeListener(expertListener);
         restoreSettings();
+
+        // if no bounding box is selected make sure it is still propagated.
+        if (currentBounds == null) {
+            boundingBoxChanged(null, null);
+        }
     }
 
     /**
@@ -314 +326 @@
 
     /**
      * Determines if the dialog autorun is enabled in preferences.
-     * @return {@code true} if the download dialog must be open at startup, {@code false} otherwise
+     * @return {@code true} if the download dialog must be open at startup, {@code false} otherwise.
      */
     public static boolean isAutorunEnabled() {
         return DOWNLOAD_AUTORUN.get();
@@ -321 +333 @@
     }
 
     /**
-     * Adds a new download area selector to the download dialog
+     * Adds a new download area selector to the download dialog.
      *
-     * @param selector the download are selector
-     * @param displayName the display name of the selector
+     * @param selector the download are selector.
+     * @param displayName the display name of the selector.
      */
     public void addDownloadAreaSelector(JPanel selector, String displayName) {
         tpDownloadAreaSelectors.add(displayName, selector);
@@ -331 +343 @@
     }
 
     /**
-     * Adds a new download source to the download dialog
+     * Adds a new download source to the download dialog if it is not added.
      *
      * @param downloadSource The download source to be added.
      * @param <T> The type of the download data.
+     * @throws JosmRuntimeException If the download source is already added. Note, download sources are
+     * compared by their reference.
      */
     public <T> void addDownloadSource(DownloadSource<T> downloadSource) {
+        if (downloadSources.contains(downloadSource)) {
+            throw new JosmRuntimeException("The download source you are trying to add already exists.");
+        }
+
+        downloadSources.add(downloadSource);
         if ((ExpertToggleAction.isExpert() && downloadSource.onlyExpert()) || !downloadSource.onlyExpert()) {
             addNewDownloadSourceTab(downloadSource);
         }
@@ -343 +362 @@
     }
 
     /**
-     * Refreshes the tile sources
+     * Refreshes the tile sources.
      * @since 6364
      */
     public final void refreshTileSources() {
@@ -358 +377 @@
     public void rememberSettings() {
         DOWNLOAD_TAB.put(tpDownloadAreaSelectors.getSelectedIndex());
         DOWNLOAD_SOURCE_TAB.put(downloadSourcesTab.getSelectedIndex());
-        DIALOG_SPLIT.put(dialogSplit.getDividerLocation());
         DOWNLOAD_NEWLAYER.put(cbNewLayer.isSelected());
         DOWNLOAD_ZOOMTODATA.put(cbZoomToDownloadedData.isSelected());
         if (currentBounds != null) {
@@ -373 +391 @@
         cbNewLayer.setSelected(DOWNLOAD_NEWLAYER.get());
         cbStartup.setSelected(isAutorunEnabled());
         cbZoomToDownloadedData.setSelected(DOWNLOAD_ZOOMTODATA.get());
-        dialogSplit.setDividerLocation(DIALOG_SPLIT.get());
 
         try {
             tpDownloadAreaSelectors.setSelectedIndex(DOWNLOAD_TAB.get());
@@ -407 +424 @@
 
     /**
      * Returns the previously saved bounding box from preferences.
-     * @return The bounding box saved in preferences if any, {@code null} otherwise
+     * @return The bounding box saved in preferences if any, {@code null} otherwise.
      * @since 6509
      */
     public static Bounds getSavedDownloadBounds() {
@@ -499 +516 @@
      * @param downloadSource The download source to be added.
      * @param <T> The type of the download data.
      */
-    private <T> void addNewDownloadSourceTab(DownloadSource<T> downloadSource) {
+    protected <T> void addNewDownloadSourceTab(DownloadSource<T> downloadSource) {
         AbstractDownloadSourcePanel<T> panel = downloadSource.createPanel();
         downloadSourcesTab.add(panel, downloadSource.getLabel());
         Icon icon = panel.getIcon();
@@ -535 +552 @@
     }
 
     /**
+     * Creates a listener that reacts on tab switches for {@code downloadSourcesTab} in order
+     * to adjust proper division of the dialog according to user saved preferences or minimal size
+     * of the panel.
+     * @return A listener to adjust dialog division.
+     */
+    private ChangeListener getDownloadSourceTabChangeListener() {
+        return ec -> {
+            JTabbedPane tabbedPane = (JTabbedPane) ec.getSource();
+            Component selectedComponent = tabbedPane.getSelectedComponent();
+            if (selectedComponent instanceof AbstractDownloadSourcePanel) {
+                AbstractDownloadSourcePanel<?> panel = (AbstractDownloadSourcePanel<?>) selectedComponent;
+                dialogSplit.setDividerLocation(Main.pref.getInteger(
+                        TAB_SPLIT_NAMESPACE + panel.getSimpleName(),
+                        panel.getMinimumSize().height));
+            }
+        };
+    }
+
+    /**
+     * Creates a listener that react on dialog splitters movements to save users preferences.
+     * @return A listener to save user preferred split of the dialog.
+     */
+    private PropertyChangeListener getDividerChangedListener() {
+        return evt -> {
+            if (evt.getPropertyName().equalsIgnoreCase(JSplitPane.DIVIDER_LOCATION_PROPERTY)) {
+                Component selectedComponent = downloadSourcesTab.getSelectedComponent();
+                if (selectedComponent instanceof AbstractDownloadSourcePanel) {
+                    AbstractDownloadSourcePanel<?> panel = (AbstractDownloadSourcePanel<?>) selectedComponent;
+                    Main.pref.put(
+                            TAB_SPLIT_NAMESPACE + panel.getSimpleName(),
+                            String.valueOf(dialogSplit.getDividerLocation())
+                    );
+                }
+            }
+        };
+    }
+
+    /**
      * Action that is executed when the cancel button is pressed.
      */
     class CancelAction extends AbstractAction {
@@ -554 +609 @@
 
         @Override
         public void actionPerformed(ActionEvent e) {
-            AbstractDownloadSourcePanel<?> pnl = (AbstractDownloadSourcePanel<?>) downloadSourcesTab.getSelectedComponent();
-            run();
-            pnl.checkCancel();
+            Component panel = downloadSourcesTab.getSelectedComponent();
+            if (panel instanceof AbstractDownloadSourcePanel) {
+                AbstractDownloadSourcePanel<?> pnl = (AbstractDownloadSourcePanel<?>) panel;
+                run();
+                pnl.checkCancel();
+            } else {
+                run();
+            }
         }
     }
 
@@ -572 +632 @@
         }
 
         /**
-         * Starts the download, if possible
+         * Starts the download and closes the dialog, if all requirements for the current download source are met.
+         * Otherwise the download is not started and the dialog remains visible.
          */
         public void run() {
             Component panel = downloadSourcesTab.getSelectedComponent();

src/org/openstreetmap/josm/gui/download/DownloadSettings.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.gui.download;
 
+import org.openstreetmap.josm.data.Bounds;
+
 import java.util.Optional;
 
-import org.openstreetmap.josm.data.Bounds;
-
 /**
  * The global settings of {@link DownloadDialog}.
  * <p>
@@ -51 +51 @@
      * @return The bounds or an empty {@link Optional} if no bounds are selected
      */
     public Optional<Bounds> getDownloadBounds() {
-        if (downloadBounds == null) {
-            return Optional.empty();
-        } else {
-            return Optional.of(downloadBounds);
-        }
+        return Optional.ofNullable(downloadBounds);
     }
 }

src/org/openstreetmap/josm/gui/download/DownloadSource.java

@@ -30 +30 @@
     String getLabel();
 
     /**
-     * Add a download source to the dialog, see {@link DownloadDialog}.
-     * @param dialog The download dialog.
-     */
-    void addGui(DownloadDialog dialog);
-
-    /**
      * Defines whether this download source should be visible only in the expert mode.
      * @return Returns {@code true} if the download source should be visible only in the
      * expert mode, {@code false} otherwise.

src/org/openstreetmap/josm/gui/download/OSMDownloadSource.java

@@ -4 +4 @@
 import static org.openstreetmap.josm.tools.I18n.tr;
 
 import java.awt.Color;
+import java.awt.Dimension;
 import java.awt.Font;
 import java.awt.GridBagLayout;
 import java.util.ArrayList;
@@ -117 +118 @@
     }
 
     @Override
-    public void addGui(DownloadDialog dialog) {
-        dialog.addDownloadSource(this);
-    }
-
-    @Override
     public boolean onlyExpert() {
         return false;
     }
@@ -137 +133 @@
         private final JCheckBox cbDownloadNotes;
         private final JLabel sizeCheck = new JLabel();
 
+        private static final String SIMPLE_NAME = "osmdownloadpanel";
         private static final BooleanProperty DOWNLOAD_OSM = new BooleanProperty("download.osm.data", true);
         private static final BooleanProperty DOWNLOAD_GPS = new BooleanProperty("download.osm.gps", false);
         private static final BooleanProperty DOWNLOAD_NOTES = new BooleanProperty("download.osm.notes", false);
 
         /**
-         * Creates a new {@link OSMDownloadSourcePanel}
-         * @param ds The osm download source the panel is for
+         * Creates a new {@link OSMDownloadSourcePanel}.
+         * @param ds The osm download source the panel is for.
          */
         public OSMDownloadSourcePanel(OSMDownloadSource ds) {
             super(ds);
@@ -174 +171 @@
             add(cbDownloadGpxData, GBC.std().insets(1, 5, 1, 5));
             add(cbDownloadNotes, GBC.eol().insets(1, 5, 1, 5));
             add(sizeCheck, GBC.eol().anchor(GBC.EAST).insets(5, 5, 5, 2));
+
+            setMinimumSize(new Dimension(450, 115));
         }
 
         @Override
@@ -277 +276 @@
             updateSizeCheck(bbox);
         }
 
+        @Override
+        public String getSimpleName() {
+            return SIMPLE_NAME;
+        }
+
         private void updateSizeCheck(Bounds bbox) {
-            boolean isAreaTooLarge = false;
             if (bbox == null) {
                 sizeCheck.setText(tr("No area selected yet"));
                 sizeCheck.setForeground(Color.darkGray);
-            } else if (!isDownloadNotes() && !isDownloadOsmData() && !isDownloadGpxData()) {
+                return;
+            }
+
+            boolean isAreaTooLarge = false;
+            if (!isDownloadNotes() && !isDownloadOsmData() && !isDownloadGpxData()) {
                 isAreaTooLarge = false;
             } else if (isDownloadNotes() && !isDownloadOsmData() && !isDownloadGpxData()) {
                 // see max_note_request_area in https://github.com/openstreetmap/openstreetmap-website/blob/master/config/example.application.yml

src/org/openstreetmap/josm/gui/download/OverpassDownloadSource.java

@@ -70 +70 @@
     }
 
     @Override
-    public void addGui(DownloadDialog dialog) {
-        dialog.addDownloadSource(this);
-    }
-
-    @Override
     public boolean onlyExpert() {
         return true;
     }
@@ -88 +83 @@
         private JosmTextArea overpassQuery;
         private OverpassQueryList overpassQueryList;
 
+        private static final String SIMPLE_NAME = "overpassdownloadpanel";
         private static final BooleanProperty OVERPASS_QUERY_LIST_OPENED =
                 new BooleanProperty("download.overpass.query-list.opened", false);
         private static final String ACTION_IMG_SUBDIR = "dialogs";
@@ -179 +175 @@
             add(leftPanel, BorderLayout.WEST);
             add(innerPanel, BorderLayout.CENTER);
             add(listPanel, BorderLayout.EAST);
+
+            setMinimumSize(new Dimension(450, 240));
         }
 
         @Override
@@ -274 +272 @@
             return ImageProvider.get("download-overpass");
         }
 
+        @Override
+        public String getSimpleName() {
+            return SIMPLE_NAME;
+        }
+
         /**
          * Action that delegates snippet creation to {@link OverpassQueryList#createNewItem()}.
          */