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