001// License: GPL. See LICENSE file for details.
002package org.openstreetmap.josm.gui.layer.geoimage;
003
004import static org.openstreetmap.josm.tools.I18n.tr;
005
006import java.awt.BorderLayout;
007import java.awt.Component;
008import java.awt.Dimension;
009import java.awt.GridBagConstraints;
010import java.awt.GridBagLayout;
011import java.awt.event.ActionEvent;
012import java.awt.event.KeyEvent;
013import java.awt.event.WindowEvent;
014import java.text.DateFormat;
015
016import javax.swing.AbstractAction;
017import javax.swing.Box;
018import javax.swing.ImageIcon;
019import javax.swing.JButton;
020import javax.swing.JComponent;
021import javax.swing.JPanel;
022import javax.swing.JToggleButton;
023
024import org.openstreetmap.josm.Main;
025import org.openstreetmap.josm.gui.MapView;
026import org.openstreetmap.josm.gui.MapView.LayerChangeListener;
027import org.openstreetmap.josm.gui.dialogs.DialogsPanel.Action;
028import org.openstreetmap.josm.gui.dialogs.ToggleDialog;
029import org.openstreetmap.josm.gui.layer.Layer;
030import org.openstreetmap.josm.tools.ImageProvider;
031import org.openstreetmap.josm.tools.Shortcut;
032import org.openstreetmap.josm.tools.date.DateUtils;
033
034public final class ImageViewerDialog extends ToggleDialog implements LayerChangeListener {
035
036    private static final String COMMAND_ZOOM = "zoom";
037    private static final String COMMAND_CENTERVIEW = "centre";
038    private static final String COMMAND_NEXT = "next";
039    private static final String COMMAND_REMOVE = "remove";
040    private static final String COMMAND_REMOVE_FROM_DISK = "removefromdisk";
041    private static final String COMMAND_PREVIOUS = "previous";
042    private static final String COMMAND_COLLAPSE = "collapse";
043    private static final String COMMAND_FIRST = "first";
044    private static final String COMMAND_LAST = "last";
045    private static final String COMMAND_COPY_PATH = "copypath";
046
047    private ImageDisplay imgDisplay = new ImageDisplay();
048    private boolean centerView = false;
049
050    // Only one instance of that class is present at one time
051    private static ImageViewerDialog dialog;
052
053    private boolean collapseButtonClicked = false;
054
055    static void newInstance() {
056        dialog = new ImageViewerDialog();
057    }
058
059    /**
060     * Replies the unique instance of this dialog
061     * @return the unique instance
062     */
063    public static ImageViewerDialog getInstance() {
064        if (dialog == null)
065            throw new AssertionError("a new instance needs to be created first");
066        return dialog;
067    }
068
069    private JButton btnNext;
070    private JButton btnPrevious;
071    private JButton btnCollapse;
072
073    private ImageViewerDialog() {
074        super(tr("Geotagged Images"), "geoimage", tr("Display geotagged images"), Shortcut.registerShortcut("tools:geotagged",
075        tr("Tool: {0}", tr("Display geotagged images")), KeyEvent.VK_Y, Shortcut.DIRECT), 200);
076
077        JPanel content = new JPanel();
078        content.setLayout(new BorderLayout());
079
080        content.add(imgDisplay, BorderLayout.CENTER);
081
082        Dimension buttonDim = new Dimension(26,26);
083
084        ImageAction prevAction = new ImageAction(COMMAND_PREVIOUS, ImageProvider.get("dialogs", "previous"), tr("Previous"));
085        btnPrevious = new JButton(prevAction);
086        btnPrevious.setPreferredSize(buttonDim);
087        Shortcut scPrev = Shortcut.registerShortcut(
088                "geoimage:previous", tr("Geoimage: {0}", tr("Show previous Image")), KeyEvent.VK_PAGE_UP, Shortcut.DIRECT);
089        final String APREVIOUS = "Previous Image";
090        Main.registerActionShortcut(prevAction, scPrev);
091        btnPrevious.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(scPrev.getKeyStroke(), APREVIOUS);
092        btnPrevious.getActionMap().put(APREVIOUS, prevAction);
093        btnPrevious.setEnabled(false);
094
095        final String DELETE_TEXT = tr("Remove photo from layer");
096        ImageAction delAction = new ImageAction(COMMAND_REMOVE, ImageProvider.get("dialogs", "delete"), DELETE_TEXT);
097        JButton btnDelete = new JButton(delAction);
098        btnDelete.setPreferredSize(buttonDim);
099        Shortcut scDelete = Shortcut.registerShortcut(
100                "geoimage:deleteimagefromlayer", tr("Geoimage: {0}", tr("Remove photo from layer")), KeyEvent.VK_DELETE, Shortcut.SHIFT);
101        Main.registerActionShortcut(delAction, scDelete);
102        btnDelete.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(scDelete.getKeyStroke(), DELETE_TEXT);
103        btnDelete.getActionMap().put(DELETE_TEXT, delAction);
104
105        ImageAction delFromDiskAction = new ImageAction(COMMAND_REMOVE_FROM_DISK, ImageProvider.get("dialogs", "geoimage/deletefromdisk"), tr("Delete image file from disk"));
106        JButton btnDeleteFromDisk = new JButton(delFromDiskAction);
107        btnDeleteFromDisk.setPreferredSize(buttonDim);
108        Shortcut scDeleteFromDisk = Shortcut.registerShortcut(
109                "geoimage:deletefilefromdisk", tr("Geoimage: {0}", tr("Delete File from disk")), KeyEvent.VK_DELETE, Shortcut.CTRL_SHIFT);
110        final String ADELFROMDISK = "Delete image file from disk";
111        Main.registerActionShortcut(delFromDiskAction, scDeleteFromDisk);
112        btnDeleteFromDisk.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(scDeleteFromDisk.getKeyStroke(), ADELFROMDISK);
113        btnDeleteFromDisk.getActionMap().put(ADELFROMDISK, delFromDiskAction);
114
115        ImageAction copyPathAction = new ImageAction(COMMAND_COPY_PATH, ImageProvider.get("copy"), tr("Copy image path"));
116        JButton btnCopyPath = new JButton(copyPathAction);
117        btnCopyPath.setPreferredSize(buttonDim);
118        Shortcut scCopyPath = Shortcut.registerShortcut(
119                "geoimage:copypath", tr("Geoimage: {0}", tr("Copy image path")), KeyEvent.VK_C, Shortcut.ALT_CTRL_SHIFT);
120        final String ACOPYPATH = "Copy image path";
121        Main.registerActionShortcut(copyPathAction, scCopyPath);
122        btnCopyPath.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(scCopyPath.getKeyStroke(), ACOPYPATH);
123        btnCopyPath.getActionMap().put(ACOPYPATH, copyPathAction);
124
125        ImageAction nextAction = new ImageAction(COMMAND_NEXT, ImageProvider.get("dialogs", "next"), tr("Next"));
126        btnNext = new JButton(nextAction);
127        btnNext.setPreferredSize(buttonDim);
128        Shortcut scNext = Shortcut.registerShortcut(
129                "geoimage:next", tr("Geoimage: {0}", tr("Show next Image")), KeyEvent.VK_PAGE_DOWN, Shortcut.DIRECT);
130        final String ANEXT = "Next Image";
131        Main.registerActionShortcut(nextAction, scNext);
132        btnNext.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(scNext.getKeyStroke(), ANEXT);
133        btnNext.getActionMap().put(ANEXT, nextAction);
134        btnNext.setEnabled(false);
135
136        Main.registerActionShortcut(
137                new ImageAction(COMMAND_FIRST, null, null),
138                Shortcut.registerShortcut(
139                        "geoimage:first", tr("Geoimage: {0}", tr("Show first Image")), KeyEvent.VK_HOME, Shortcut.DIRECT)
140        );
141        Main.registerActionShortcut(
142                new ImageAction(COMMAND_LAST, null, null),
143                Shortcut.registerShortcut(
144                        "geoimage:last", tr("Geoimage: {0}", tr("Show last Image")), KeyEvent.VK_END, Shortcut.DIRECT)
145        );
146
147        JToggleButton tbCentre = new JToggleButton(new ImageAction(COMMAND_CENTERVIEW, ImageProvider.get("dialogs", "centreview"), tr("Center view")));
148        tbCentre.setPreferredSize(buttonDim);
149
150        JButton btnZoomBestFit = new JButton(new ImageAction(COMMAND_ZOOM, ImageProvider.get("dialogs", "zoom-best-fit"), tr("Zoom best fit and 1:1")));
151        btnZoomBestFit.setPreferredSize(buttonDim);
152
153        btnCollapse = new JButton(new ImageAction(COMMAND_COLLAPSE, ImageProvider.get("dialogs", "collapse"), tr("Move dialog to the side pane")));
154        btnCollapse.setPreferredSize(new Dimension(20,20));
155        btnCollapse.setAlignmentY(Component.TOP_ALIGNMENT);
156
157        JPanel buttons = new JPanel();
158        buttons.add(btnPrevious);
159        buttons.add(btnNext);
160        buttons.add(Box.createRigidArea(new Dimension(7, 0)));
161        buttons.add(tbCentre);
162        buttons.add(btnZoomBestFit);
163        buttons.add(Box.createRigidArea(new Dimension(7, 0)));
164        buttons.add(btnDelete);
165        buttons.add(btnDeleteFromDisk);
166        buttons.add(Box.createRigidArea(new Dimension(7, 0)));
167        buttons.add(btnCopyPath);
168
169        JPanel bottomPane = new JPanel();
170        bottomPane.setLayout(new GridBagLayout());
171        GridBagConstraints gc = new GridBagConstraints();
172        gc.gridx = 0;
173        gc.gridy = 0;
174        gc.anchor = GridBagConstraints.CENTER;
175        gc.weightx = 1;
176        bottomPane.add(buttons, gc);
177
178        gc.gridx = 1;
179        gc.gridy = 0;
180        gc.anchor = GridBagConstraints.PAGE_END;
181        gc.weightx = 0;
182        bottomPane.add(btnCollapse, gc);
183
184        content.add(bottomPane, BorderLayout.SOUTH);
185
186        add(content, BorderLayout.CENTER);
187
188        MapView.addLayerChangeListener(this);
189    }
190
191    @Override
192    public void destroy() {
193        MapView.removeLayerChangeListener(this);
194        super.destroy();
195    }
196
197    class ImageAction extends AbstractAction {
198        private final String action;
199        public ImageAction(String action, ImageIcon icon, String toolTipText) {
200            this.action = action;
201            putValue(SHORT_DESCRIPTION, toolTipText);
202            putValue(SMALL_ICON, icon);
203        }
204
205        @Override
206        public void actionPerformed(ActionEvent e) {
207            if (COMMAND_NEXT.equals(action)) {
208                if (currentLayer != null) {
209                    currentLayer.showNextPhoto();
210                }
211            } else if (COMMAND_PREVIOUS.equals(action)) {
212                if (currentLayer != null) {
213                    currentLayer.showPreviousPhoto();
214                }
215            } else if (COMMAND_FIRST.equals(action) && currentLayer != null) {
216                currentLayer.showFirstPhoto();
217            } else if (COMMAND_LAST.equals(action) && currentLayer != null) {
218                currentLayer.showLastPhoto();
219
220            } else if (COMMAND_CENTERVIEW.equals(action)) {
221                centerView = ((JToggleButton) e.getSource()).isSelected();
222                if (centerView && currentEntry != null && currentEntry.getPos() != null) {
223                    Main.map.mapView.zoomTo(currentEntry.getPos());
224                }
225
226            } else if (COMMAND_ZOOM.equals(action)) {
227                imgDisplay.zoomBestFitOrOne();
228
229            } else if (COMMAND_REMOVE.equals(action)) {
230                if (currentLayer != null) {
231                    currentLayer.removeCurrentPhoto();
232                }
233            } else if (COMMAND_REMOVE_FROM_DISK.equals(action)) {
234                if (currentLayer != null) {
235                    currentLayer.removeCurrentPhotoFromDisk();
236                }
237            } else if (COMMAND_COPY_PATH.equals(action)) {
238                if (currentLayer != null) {
239                    currentLayer.copyCurrentPhotoPath();
240                }
241            } else if (COMMAND_COLLAPSE.equals(action)) {
242                collapseButtonClicked = true;
243                detachedDialog.getToolkit().getSystemEventQueue().postEvent(new WindowEvent(detachedDialog, WindowEvent.WINDOW_CLOSING));
244            }
245        }
246    }
247
248    public static void showImage(GeoImageLayer layer, ImageEntry entry) {
249        getInstance().displayImage(layer, entry);
250        if (layer != null) {
251            layer.checkPreviousNextButtons();
252        } else {
253            setPreviousEnabled(false);
254            setNextEnabled(false);
255        }
256    }
257
258    /**
259     * Enables (or disables) the "Previous" button.
260     * @param value {@code true} to enable the button, {@code false} otherwise
261     */
262    public static void setPreviousEnabled(boolean value) {
263        getInstance().btnPrevious.setEnabled(value);
264    }
265
266    /**
267     * Enables (or disables) the "Next" button.
268     * @param value {@code true} to enable the button, {@code false} otherwise
269     */
270    public static void setNextEnabled(boolean value) {
271        getInstance().btnNext.setEnabled(value);
272    }
273
274    private GeoImageLayer currentLayer = null;
275    private ImageEntry currentEntry = null;
276
277    public void displayImage(GeoImageLayer layer, ImageEntry entry) {
278        boolean imageChanged;
279
280        synchronized(this) {
281            // TODO: pop up image dialog but don't load image again
282
283            imageChanged = currentEntry != entry;
284
285            if (centerView && Main.isDisplayingMapView() && entry != null && entry.getPos() != null) {
286                Main.map.mapView.zoomTo(entry.getPos());
287            }
288
289            currentLayer = layer;
290            currentEntry = entry;
291        }
292
293        if (entry != null) {
294            if (imageChanged) {
295                // Set only if the image is new to preserve zoom and position if the same image is redisplayed
296                // (e.g. to update the OSD).
297                imgDisplay.setImage(entry.getFile(), entry.getExifOrientation());
298            }
299            setTitle(tr("Geotagged Images") + (entry.getFile() != null ? " - " + entry.getFile().getName() : ""));
300            StringBuilder osd = new StringBuilder(entry.getFile() != null ? entry.getFile().getName() : "");
301            if (entry.getElevation() != null) {
302                osd.append(tr("\nAltitude: {0} m", entry.getElevation().longValue()));
303            }
304            if (entry.getSpeed() != null) {
305                osd.append(tr("\n{0} km/h", Math.round(entry.getSpeed())));
306            }
307            if (entry.getExifImgDir() != null) {
308                osd.append(tr("\nDirection {0}\u00b0", Math.round(entry.getExifImgDir())));
309            }
310            DateFormat dtf = DateUtils.getDateTimeFormat(DateFormat.SHORT, DateFormat.MEDIUM);
311            if (entry.hasExifTime()) {
312                osd.append(tr("\nEXIF time: {0}", dtf.format(entry.getExifTime())));
313            }
314            if (entry.hasGpsTime()) {
315                osd.append(tr("\nGPS time: {0}", dtf.format(entry.getGpsTime())));
316            }
317
318            imgDisplay.setOsdText(osd.toString());
319        } else {
320            // if this method is called to reinitialize dialog content with a blank image,
321            // do not actually show the dialog again with a blank image if currently hidden (fix #10672)
322            setTitle(tr("Geotagged Images"));
323            imgDisplay.setImage(null, null);
324            imgDisplay.setOsdText("");
325            return;
326        }
327        if (! isDialogShowing()) {
328            setIsDocked(false);     // always open a detached window when an image is clicked and dialog is closed
329            showDialog();
330        } else {
331            if (isDocked && isCollapsed) {
332                expand();
333                dialogsPanel.reconstruct(Action.COLLAPSED_TO_DEFAULT, this);
334            }
335        }
336    }
337
338    /**
339     * When an image is closed, really close it and do not pop
340     * up the side dialog.
341     */
342    @Override
343    protected boolean dockWhenClosingDetachedDlg() {
344        if (collapseButtonClicked) {
345            collapseButtonClicked = false;
346            return true;
347        }
348        return false;
349    }
350
351    @Override
352    protected void stateChanged() {
353        super.stateChanged();
354        if (btnCollapse != null) {
355            btnCollapse.setVisible(!isDocked);
356        }
357    }
358
359    /**
360     * Returns whether an image is currently displayed
361     * @return If image is currently displayed
362     */
363    public boolean hasImage() {
364        return currentEntry != null;
365    }
366
367    /**
368     * Returns the currently displayed image.
369     * @return Currently displayed image or {@code null}
370     * @since 6392
371     */
372    public static ImageEntry getCurrentImage() {
373        return getInstance().currentEntry;
374    }
375
376    /**
377     * Returns the layer associated with the image.
378     * @return Layer associated with the image
379     * @since 6392
380     */
381    public static GeoImageLayer getCurrentLayer() {
382        return getInstance().currentLayer;
383    }
384
385    @Override
386    public void activeLayerChange(Layer oldLayer, Layer newLayer) {
387        if (currentLayer == null && newLayer instanceof GeoImageLayer) {
388            ((GeoImageLayer)newLayer).showFirstPhoto();
389        }
390    }
391
392    @Override
393    public void layerAdded(Layer newLayer) {
394        if (currentLayer == null && newLayer instanceof GeoImageLayer) {
395            ((GeoImageLayer)newLayer).showFirstPhoto();
396        }
397    }
398
399    @Override
400    public void layerRemoved(Layer oldLayer) {
401        // Clear current image and layer if current layer is deleted
402        if (currentLayer != null && currentLayer.equals(oldLayer)) {
403            showImage(null, null);
404        }
405        // Check buttons state in case of layer merging
406        if (currentLayer != null && oldLayer instanceof GeoImageLayer) {
407            currentLayer.checkPreviousNextButtons();
408        }
409    }
410}