Changeset 6299 in josm for trunk

Timestamp:

2013-10-06T17:26:37+02:00 (11 years ago)

Author:

Don-vip

Message:

Improve feedback when clicking a web marker pointing to a local file fails

Location:

trunk/src/org/openstreetmap/josm

Files:

• Main.java (modified) (2 diffs)
• gui/layer/markerlayer/ButtonMarker.java (modified) (1 diff)
• gui/layer/markerlayer/Marker.java (modified) (10 diffs)
• gui/layer/markerlayer/PlayHeadMarker.java (modified) (1 diff)
• gui/layer/markerlayer/WebMarker.java (modified) (5 diffs)
• tools/OpenBrowser.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/Main.java

@@ -293 +293 @@
      */
     public static void error(Throwable t) {
-        error(t.getClass().getName()+": "+t.getMessage());
+        error(t.getClass().getName()+": "+t.getMessage().trim());
     }
     
@@ -302 +302 @@
      */
     public static void warn(Throwable t) {
-        warn(t.getClass().getName()+": "+t.getMessage());
+        warn(t.getClass().getName()+": "+t.getMessage().trim());
     }
 

trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/ButtonMarker.java

@@ -49 +49 @@
         Point screen = mv.getPoint(getEastNorth());
         buttonRectangle.setLocation(screen.x+4, screen.y+2);
-        symbol.paintIcon(mv, g, screen.x+4, screen.y+2);
+        paintIcon(mv, g, screen.x+4, screen.y+2);
         Border b;
         Point mousePosition = mv.getMousePosition();

trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/Marker.java

@@ -2 +2 @@
 package org.openstreetmap.josm.gui.layer.markerlayer;
 
+import java.awt.AlphaComposite;
+import java.awt.Color;
 import java.awt.Graphics;
+import java.awt.Graphics2D;
 import java.awt.Point;
 import java.awt.event.ActionEvent;
+import java.awt.image.BufferedImage;
 import java.io.File;
 import java.net.MalformedURLException;
@@ -19 +23 @@
 import java.util.TimeZone;
 
-import javax.swing.Icon;
+import javax.swing.ImageIcon;
 
 import org.openstreetmap.josm.Main;
@@ -279 +283 @@
     private final String text;
 
-    public final Icon symbol;
+    protected final ImageIcon symbol;
+    private BufferedImage redSymbol = null;
     public final MarkerLayer parentLayer;
-    public double time; /* absolute time of marker in seconds since epoch */
-    public double offset; /* time offset in seconds from the gpx point from which it was derived,
-                             may be adjusted later to sync with other data, so not final */
+    /** Absolute time of marker in seconds since epoch */
+    public double time;
+    /** Time offset in seconds from the gpx point from which it was derived, may be adjusted later to sync with other data, so not final */
+    public double offset; 
 
     private String cachedText;
     private int textVersion = -1;
     private CachedLatLon coor;
+    
+    private boolean erroneous = false;
 
     public Marker(LatLon ll, TemplateEngineDataProvider dataProvider, String iconName, MarkerLayer parentLayer, double time, double offset) {
@@ -294 +302 @@
         this.offset = offset;
         this.time = time;
-        // /* ICON(markers/) */"Bridge"
-        // /* ICON(markers/) */"Crossing"
         this.symbol = iconName != null ? ImageProvider.getIfAvailable("markers",iconName) : null;
         this.parentLayer = parentLayer;
@@ -308 +314 @@
         this.offset = offset;
         this.time = time;
-        // /* ICON(markers/) */"Bridge"
-        // /* ICON(markers/) */"Crossing"
         this.symbol = iconName != null ? ImageProvider.getIfAvailable("markers",iconName) : null;
         this.parentLayer = parentLayer;
@@ -340 +344 @@
     }
 
+    /**
+     * Sets the marker's coordinates.
+     * @param coor The marker's coordinates (lat/lon)
+     */
     public final void setCoor(LatLon coor) {
         this.coor = new CachedLatLon(coor);
     }
 
+    /**
+     * Returns the marker's coordinates.
+     * @return The marker's coordinates (lat/lon)
+     */
     public final LatLon getCoor() {
         return coor;
     }
 
+    /**
+     * Sets the marker's projected coordinates.
+     * @param eastNorth The marker's projected coordinates (easting/northing)
+     */
     public final void setEastNorth(EastNorth eastNorth) {
         this.coor = new CachedLatLon(eastNorth);
     }
 
+    /**
+     * Returns the marker's projected coordinates.
+     * @return The marker's projected coordinates (easting/northing)
+     */
     public final EastNorth getEastNorth() {
         return coor.getEastNorth();
     }
-
 
     /**
@@ -377 +396 @@
     }
 
-
     /**
      * Paints the marker.
@@ -388 +406 @@
         Point screen = mv.getPoint(getEastNorth());
         if (symbol != null && showTextOrIcon) {
-            symbol.paintIcon(mv, g, screen.x-symbol.getIconWidth()/2, screen.y-symbol.getIconHeight()/2);
+            paintIcon(mv, g, screen.x-symbol.getIconWidth()/2, screen.y-symbol.getIconHeight()/2);
         } else {
             g.drawLine(screen.x-2, screen.y-2, screen.x+2, screen.y+2);
@@ -399 +417 @@
         }
     }
-
+    
+    protected void paintIcon(MapView mv, Graphics g, int x, int y) {
+        if (!erroneous) {
+            symbol.paintIcon(mv, g, x, y);
+        } else {
+            if (redSymbol == null) {
+                int width = symbol.getIconWidth();
+                int height = symbol.getIconHeight();
+                                
+                redSymbol = new BufferedImage(width, height, BufferedImage.TYPE_INT_ARGB);
+                Graphics2D gbi = redSymbol.createGraphics();
+                gbi.drawImage(symbol.getImage(), 0, 0, null);
+                gbi.setColor(Color.RED);
+                gbi.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, 0.666f));
+                gbi.fillRect(0, 0, width, height);
+                gbi.dispose();
+            }
+            g.drawImage(redSymbol, x, y, mv);
+        }
+    }
 
     protected TemplateEntryProperty getTextTemplate() {
@@ -465 +502 @@
         throw new UnsupportedOperationException();
     }
+    
+    /**
+     * Determines if this marker is erroneous.
+     * @return {@code true} if this markers has any kind of error, {@code false} otherwise
+     * @since 6299
+     */
+    public final boolean isErroneous() {
+        return erroneous;
+    }
+    
+    /**
+     * Sets this marker erroneous or not.
+     * @param erroneous {@code true} if this markers has any kind of error, {@code false} otherwise
+     * @since 6299
+     */
+    public final void setErroneous(boolean erroneous) {
+        this.erroneous = erroneous;
+        if (!erroneous) {
+            redSymbol = null;
+        }
+    }
 }

trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/PlayHeadMarker.java

@@ -274 +274 @@
         if (time < 0.0) return;
         Point screen = mv.getPoint(getEastNorth());
-        symbol.paintIcon(mv, g, screen.x, screen.y);
+        paintIcon(mv, g, screen.x, screen.y);
     }
 

trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/WebMarker.java

@@ -5 +5 @@
 
 import java.awt.event.ActionEvent;
+import java.io.File;
 import java.net.URL;
 import java.util.Collections;
@@ -15 +16 @@
 import org.openstreetmap.josm.data.gpx.GpxLink;
 import org.openstreetmap.josm.data.gpx.WayPoint;
+import org.openstreetmap.josm.gui.Notification;
+import org.openstreetmap.josm.tools.CheckParameterUtil;
 import org.openstreetmap.josm.tools.OpenBrowser;
 
@@ -25 +28 @@
 public class WebMarker extends ButtonMarker {
 
-    public final URL webUrl;
+    private final URL webUrl;
 
     public WebMarker(LatLon ll, URL webUrl, MarkerLayer parentLayer, double time, double offset) {
         super(ll, "web.png", parentLayer, time, offset);
+        CheckParameterUtil.ensureParameterNotNull(webUrl, "webUrl");
         this.webUrl = webUrl;
     }
@@ -35 +39 @@
         String error = OpenBrowser.displayUrl(webUrl.toString());
         if (error != null) {
-            JOptionPane.showMessageDialog(Main.parent,
-                    "<html><b>" +
-                            tr("There was an error while trying to display the URL for this marker") +
-                            "</b><br>" + tr("(URL was: ") + webUrl.toString() + ")" + "<br>" + error,
-                            tr("Error displaying URL"), JOptionPane.ERROR_MESSAGE);
+            setErroneous(true);
+            new Notification(
+                    "<b>" + tr("There was an error while trying to display the URL for this marker") + "</b><br>" + 
+                                  tr("(URL was: ") + webUrl.toString() + ")" + "<br>" + error)
+                    .setIcon(JOptionPane.ERROR_MESSAGE)
+                    .setDuration(Notification.TIME_LONG)
+                    .show();
+        } else {
+            updateErroneous();
         }
     }
@@ -51 +59 @@
         return wpt;
     }
+    
+    private final void updateErroneous() {
+        if ("file".equals(webUrl.getProtocol())) {
+            String path = webUrl.getPath();
+            try {
+                setErroneous(path.isEmpty() || !new File(path).exists());
+            } catch (Exception e) {
+                Main.warn(e);
+                setErroneous(true);
+            }
+        } else {
+            setErroneous(false);
+        }
+    }
 }

trunk/src/org/openstreetmap/josm/tools/OpenBrowser.java

@@ -29 +29 @@
 
     /**
+     * Displays an external URI using platform associated software. 
+     * A web resource will launch platform's browser, an audio file URI will launch audio player, etc. 
+     * @param uri The URI to display
      * @return <code>null</code> for success or a string in case of an error.
      * @throws IllegalStateException thrown if no platform is set to which opening the URL can be dispatched,
@@ -34 +37 @@
      */
     public static String displayUrl(URI uri) {
+        CheckParameterUtil.ensureParameterNotNull(uri, "uri");
         if (Main.applet) {
             try {
@@ -43 +47 @@
             }
         }
+        
+        Main.info(tr("Opening URL: {0}", uri));
 
         if (Desktop.isDesktopSupported()) {
             try {
-                try {
+                if (Main.platform instanceof PlatformHookWindows) {
+                    // Desktop API works fine under Windows, so we don't try any fallback in case of I/O exceptions because it's not API's fault
                     Desktop.getDesktop().browse(uri);
-                } catch (IOException e) {
-                    // Workaround for KDE (Desktop API is severely flawed)
-                    // see http://bugs.sun.com/view_bug.do?bug_id=6486393
-                    Main.warn("Desktop class failed. Platform dependent fall back for open url in browser.");
-                    displayUrlFallback(uri);
+                } else {
+                    // This is not the case with some Linux environments (see below), and not sure about Mac OS X, so we need to handle API failure
+                    try {
+                        Desktop.getDesktop().browse(uri);
+                    } catch (IOException e) {
+                        // Workaround for KDE (Desktop API is severely flawed)
+                        // see https://bugs.openjdk.java.net/browse/JDK-6486393
+                        Main.warn("Desktop class failed. Platform dependent fall back for open url in browser.");
+                        displayUrlFallback(uri);
+                    }
                 }
             } catch (Exception e) {
-                e.printStackTrace();
+                Main.warn(e);
                 return e.getMessage();
             }
@@ -69 +81 @@
     }
 
+    /**
+     * Displays an external URL using platform associated software. 
+     * A web resource will launch platform's browser, an audio file URL will launch audio player, etc. 
+     * @param url The URL to display
+     * @return <code>null</code> for success or a string in case of an error.
+     * @throws IllegalStateException thrown if no platform is set to which opening the URL can be dispatched,
+     * {@link Main#platform}
+     */
     public static String displayUrl(String url) {
         try {