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