Fix #21605: Add tabs to ImageViewerDialog for use with different image layers

This allows users to have multiple geotagged image layers, and
quickly switch between them.

This is a complete rework of the functionality introduced in r18591 after user feedback.

Changes:
* Tabs are now scrollable
* Tabs now have a close button
* Removes the functions where plugins could send a layer in (plugins should use
  IGeoImageLayer instead)
* Tabs are sorted (by layer order)
* GeoImageLayers will use a darker red for selected but not viewed images
* Tabs are only opened when the user clicks on a geoimage from a different layer
* GpxMarkers now implement IQuadBucketType. This was to speed up the
  `containsImage` method in MarkerLayer.

git-svn-id: https://josm.openstreetmap.de/svn/trunk@18613 0c6e7542-c601-0410-84e7-c038aed88b3b

Author: taylor.smock

src/org/openstreetmap/josm/gui/layer/geoimage/GeoImageLayer.java

@@ -33,6 +33,7 @@
 
 import javax.swing.Action;
 import javax.swing.Icon;
+import javax.swing.ImageIcon;
 
 import org.openstreetmap.josm.actions.AutoScaleAction;
 import org.openstreetmap.josm.actions.ExpertToggleAction;
@@ -47,7 +48,9 @@
 import org.openstreetmap.josm.data.gpx.GpxData;
 import org.openstreetmap.josm.data.gpx.GpxImageEntry;
 import org.openstreetmap.josm.data.gpx.GpxTrack;
+import org.openstreetmap.josm.data.imagery.street_level.IImageEntry;
 import org.openstreetmap.josm.data.osm.visitor.BoundingXYVisitor;
+import org.openstreetmap.josm.data.preferences.NamedColorProperty;
 import org.openstreetmap.josm.gui.MainApplication;
 import org.openstreetmap.josm.gui.MapFrame;
 import org.openstreetmap.josm.gui.MapFrame.MapModeChangeListener;
@@ -62,22 +65,26 @@
 import org.openstreetmap.josm.gui.layer.JumpToMarkerActions.JumpToPreviousMarker;
 import org.openstreetmap.josm.gui.layer.Layer;
 import org.openstreetmap.josm.gui.layer.MainLayerManager.ActiveLayerChangeListener;
+import org.openstreetmap.josm.gui.util.GuiHelper;
 import org.openstreetmap.josm.gui.util.imagery.Vector3D;
 import org.openstreetmap.josm.tools.ImageProvider;
+import org.openstreetmap.josm.tools.ListenerList;
 import org.openstreetmap.josm.tools.Utils;
 
 /**
  * Layer displaying geotagged pictures.
  * @since 99
  */
 public class GeoImageLayer extends AbstractModifiableLayer implements
-        JumpToMarkerLayer, NavigatableComponent.ZoomChangeListener, ImageDataUpdateListener {
+        JumpToMarkerLayer, NavigatableComponent.ZoomChangeListener, ImageDataUpdateListener,
+        IGeoImageLayer {
 
     private static final List<Action> menuAdditions = new LinkedList<>();
 
     private static volatile List<MapMode> supportedMapModes;
 
     private final ImageData data;
+    private final ListenerList<IGeoImageLayer.ImageChangeListener> imageChangeListeners = ListenerList.create();
     GpxData gpxData;
     GpxLayer gpxFauxLayer;
     GpxData gpxFauxData;
@@ -86,6 +93,19 @@ public class GeoImageLayer extends AbstractModifiableLayer implements
 
     private final Icon icon = ImageProvider.get("dialogs/geoimage/photo-marker");
     private final Icon selectedIcon = ImageProvider.get("dialogs/geoimage/photo-marker-selected");
+    private final Icon selectedIconNotImageViewer = generateSelectedIconNotImageViewer(this.selectedIcon);
+
+    private static Icon generateSelectedIconNotImageViewer(Icon selectedIcon) {
+        Color color = new NamedColorProperty("geoimage.selected.not.image.viewer", new Color(50, 0, 0)).get();
+        BufferedImage bi = new BufferedImage(selectedIcon.getIconWidth(), selectedIcon.getIconHeight(), BufferedImage.TYPE_INT_ARGB);
+        Graphics2D g2d = bi.createGraphics();
+        selectedIcon.paintIcon(null, g2d, 0, 0);
+        g2d.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, 0.5f));
+        g2d.setColor(color);
+        g2d.fillRect(0, 0, selectedIcon.getIconWidth(), selectedIcon.getIconHeight());
+        g2d.dispose();
+        return new ImageIcon(bi);
+    }
 
     boolean useThumbs;
     private final ExecutorService thumbsLoaderExecutor =
@@ -172,6 +192,14 @@ public GeoImageLayer(final List<ImageEntry> data, GpxData gpxData, final String
         this.useThumbs = useThumbs;
         this.data.addImageDataUpdateListener(this);
         this.data.setLayer(this);
+        synchronized (ImageViewerDialog.class) {
+            if (!ImageViewerDialog.hasInstance()) {
+                GuiHelper.runInEDTAndWait(ImageViewerDialog::createInstance);
+            }
+        }
+        if (getInvalidGeoImages().size() == data.size()) {
+            ImageViewerDialog.getInstance().displayImages(Collections.singletonList(this.data.getFirstImage()));
+        }
     }
 
     private final class ImageMouseListener extends MouseAdapter {
@@ -232,8 +260,9 @@ public void mouseReleased(MouseEvent ev) {
                     }
                 } else {
                     data.setSelectedImage(img);
-                    ImageViewerDialog.getInstance().displayImages(GeoImageLayer.this, Collections.singletonList(img));
+                    ImageViewerDialog.getInstance().displayImages(Collections.singletonList(img));
                 }
+                GeoImageLayer.this.invalidate(); // Needed to update which image is being shown in the image viewer in the mapview
             }
         }
     }
@@ -247,11 +276,45 @@ public static void create(Collection<File> files, GpxLayer gpxLayer) {
         MainApplication.worker.execute(new ImagesLoader(files, gpxLayer));
     }
 
+    @Override
+    public void clearSelection() {
+        this.getImageData().clearSelectedImage();
+    }
+
+    @Override
+    public boolean containsImage(IImageEntry<?> imageEntry) {
+        if (imageEntry instanceof ImageEntry) {
+            return this.data.getImages().contains(imageEntry);
+        }
+        return false;
+    }
+
     @Override
     public Icon getIcon() {
         return ImageProvider.get("dialogs/geoimage", ImageProvider.ImageSizes.LAYER);
     }
 
+    @Override
+    public List<ImageEntry> getSelection() {
+        return this.getImageData().getSelectedImages();
+    }
+
+    @Override
+    public List<IImageEntry<?>> getInvalidGeoImages() {
+        return this.getImageData().getImages().stream().filter(entry -> entry.getPos() == null || entry.getExifCoor() == null
+              || !entry.getExifCoor().isValid() || !entry.getPos().isValid()).collect(toList());
+    }
+
+    @Override
+    public void addImageChangeListener(ImageChangeListener listener) {
+        this.imageChangeListeners.addListener(listener);
+    }
+
+    @Override
+    public void removeImageChangeListener(ImageChangeListener listener) {
+        this.imageChangeListeners.removeListener(listener);
+    }
+
     /**
      * Register actions on the layer
      * @param addition the action to be added
@@ -451,6 +514,7 @@ public void paint(Graphics2D g, MapView mv, Bounds bounds) {
             }
         }
 
+        final IImageEntry<?> currentImage = ImageViewerDialog.getCurrentImage();
         for (ImageEntry e: data.getSelectedImages()) {
             if (e != null && e.getPos() != null) {
                 Point p = mv.getPoint(e.getPos());
@@ -465,10 +529,14 @@ public void paint(Graphics2D g, MapView mv, Bounds bounds) {
                 if (useThumbs && e.hasThumbnail()) {
                     g.setColor(new Color(128, 0, 0, 122));
                     g.fillRect(p.x - imgDim.width / 2, p.y - imgDim.height / 2, imgDim.width, imgDim.height);
-                } else {
+                } else if (e.equals(currentImage)) {
                     selectedIcon.paintIcon(mv, g,
                             p.x - imgDim.width / 2,
                             p.y - imgDim.height / 2);
+                } else {
+                    selectedIconNotImageViewer.paintIcon(mv, g,
+                            p.x - imgDim.width / 2,
+                            p.y - imgDim.height / 2);
                 }
             }
         }
@@ -884,6 +952,7 @@ public void setUseThumbs(boolean useThumbs) {
     @Override
     public void selectedImageChanged(ImageData data) {
         showCurrentPhoto();
+        this.imageChangeListeners.fireEvent(e -> e.imageChanged(this, null, data.getSelectedImages()));
     }
 
     @Override

src/org/openstreetmap/josm/gui/layer/geoimage/IGeoImageLayer.java

@@ -0,0 +1,64 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.layer.geoimage;
+
+import java.util.Collections;
+import java.util.List;
+
+import org.openstreetmap.josm.data.imagery.street_level.IImageEntry;
+
+/**
+ * An interface for layers which want to show images
+ * @since 18613
+ */
+public interface IGeoImageLayer {
+    /**
+     * Clear the selection of the layer
+     */
+    void clearSelection();
+
+    /**
+     * Get the current selection
+     * @return The currently selected images
+     */
+    List<? extends IImageEntry<?>> getSelection();
+
+    /**
+     * Get the invalid geo images for this layer (specifically, those that <i>cannot</i> be displayed on the map)
+     * @return The list of invalid geo images
+     */
+    default List<IImageEntry<?>> getInvalidGeoImages() {
+        return Collections.emptyList();
+    }
+
+    /**
+     * Check if the layer contains the specified image
+     * @param imageEntry The entry to look for
+     * @return {@code true} if this layer contains the image
+     */
+    boolean containsImage(IImageEntry<?> imageEntry);
+
+    /**
+     * Add a listener for when images change
+     * @param listener The listener to call
+     */
+    void addImageChangeListener(ImageChangeListener listener);
+
+    /**
+     * Remove a listener for when images change
+     * @param listener The listener to remove
+     */
+    void removeImageChangeListener(ImageChangeListener listener);
+
+    /**
+     * Listen for image changes
+     */
+    interface ImageChangeListener {
+        /**
+         * Called when the selected image(s) change
+         * @param source The source of the change
+         * @param oldImages The previously selected image(s)
+         * @param newImages The newly selected image(s)
+         */
+        void imageChanged(IGeoImageLayer source, List<? extends IImageEntry<?>> oldImages, List<? extends IImageEntry<?>> newImages);
+    }
+}

src/org/openstreetmap/josm/gui/layer/geoimage/ImageEntry.java

@@ -147,7 +147,7 @@ public void selectImage(ImageViewerDialog imageViewerDialog, IImageEntry<?> entr
         if (entry instanceof ImageEntry) {
             this.dataSet.setSelectedImage((ImageEntry) entry);
         }
-        imageViewerDialog.displayImages(this.dataSet.getLayer(), Collections.singletonList(entry));
+        imageViewerDialog.displayImages(Collections.singletonList(entry));
     }
 
     @Override