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