uses JEditorPane to display messages with embedded links, fixes #293

codeanticode · codeanticode · commit a1028ce364d6 · 2017-02-14T14:11:11.000-05:00
diff --git a/src/processing/mode/android/AndroidEditor.java b/src/processing/mode/android/AndroidEditor.java
@@ -42,8 +42,6 @@
 
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
-import java.awt.event.MouseAdapter;
-import java.awt.event.MouseEvent;
 import java.io.File;
 import java.io.IOException;
 import java.util.TimerTask;
@@ -65,6 +63,16 @@ public class AndroidEditor extends JavaEditor {
   private JCheckBoxMenuItem watchfaceItem;
   private JCheckBoxMenuItem cardboardItem;
     
+  private static final String USB_DRIVER_TITLE = "USB Driver warning";
+  private static final String USB_DRIVER_URL = 
+      "http://developer.android.com/sdk/win-usb.html";
+  private static final String USB_DRIVER_MESSAGEA = 
+      "You might need to install Google USB Driver to run " +
+      "the sketch on your device. Please follow <a href=\"" + USB_DRIVER_URL + "\">this guide</a> " +
+      "to install the driver.<br>";  
+  private static final String USB_DRIVER_MESSAGEB = 
+      "<br>For your reference, the driver is located in:<br>";
+  
   protected AndroidEditor(Base base, String path, EditorState state, 
                           Mode mode) throws EditorException {
     super(base, path, state, mode);
@@ -641,56 +649,16 @@ public void run() {
    */
   public void handleRunDevice() {
     if (Platform.isWindows() && !Preferences.getBoolean("android.warnings.usb_driver")) {
-      Preferences.setBoolean("android.warnings.usb_driver", true);
-      
+      Preferences.setBoolean("android.warnings.usb_driver", true);      
       File sdkFolder = androidMode.getSDK().getSdkFolder();
-      File usbDriverFile = new File(sdkFolder, "extras/google/usb_driver");
-      JComponent[] text = null;
+      String text = "";
+      File usbDriverFile = new File(sdkFolder, "extras/google/usb_driver");      
       if (usbDriverFile.exists()) {
-        JLabel text1 = new JLabel("<html>You might need to install Google USB Driver to run<br>" +
-            "the sketch on your device.</html>");
-        JLabel text2 = new JLabel("<html>Please follow</html>");      
-        final String url1 = "http://developer.android.com/sdk/win-usb.html";
-        String urlText1 = "<html><a href=\"" + url1 + "\">this guide</a></html>";      
-        JLabel link1 = new JLabel(urlText1);
-        link1.setCursor(new java.awt.Cursor(java.awt.Cursor.HAND_CURSOR));
-        link1.addMouseListener(new MouseAdapter() {
-          public void mouseClicked(MouseEvent e) {
-            Platform.openURL(url1);
-          }
-        });
-        JLabel text3 = new JLabel("<html>to install the driver.</html>");
-        JLabel text4 = new JLabel("<html>For your reference, the driver is located in:<br>" +
-            "C:/blah/blah/blah/lala</body></html>");       
-        text = new JComponent[] { text1, text2, link1, text3, text4 };
+        text = USB_DRIVER_MESSAGEA + USB_DRIVER_MESSAGEB + usbDriverFile.getAbsolutePath();
       } else {
-        JLabel text1 = new JLabel("<html>You might need to install Google USB Driver to run the sketch<br>" +
-            "on your device.</html>");
-        JLabel text2 = new JLabel("<html>Please follow</html>");      
-        final String url1 = "http://developer.android.com/sdk/win-usb.html";
-        String urlText1 = "<html><a href=\"" + url1 + "\">this guide</a></html>";      
-        JLabel link1 = new JLabel(urlText1);
-        link1.setCursor(new java.awt.Cursor(java.awt.Cursor.HAND_CURSOR));
-        link1.addMouseListener(new MouseAdapter() {
-          public void mouseClicked(MouseEvent e) {
-            Platform.openURL(url1);
-          }
-        });
-        JLabel text3 = new JLabel("<html>to install the driver.</html>");        
-        JLabel text4 = new JLabel("<html>You will also need to download the driver from</html>");        
-        final String url2 = "https://dl-ssl.google.com/android/repository/latest_usb_driver_windows.zip";
-        String urlText2 = "<html><a href=\"" + url2 + "\">here</a>.</html>";      
-        JLabel link2 = new JLabel(urlText2);
-        link2.setCursor(new java.awt.Cursor(java.awt.Cursor.HAND_CURSOR));
-        link2.addMouseListener(new MouseAdapter() {
-          public void mouseClicked(MouseEvent e) {
-            Platform.openURL(url2);
-          }
-        });
-        text = new JComponent[] { text1, text2, link1, text3, text4, link2 };
+        text = USB_DRIVER_MESSAGEA;        
       }
-      String title = "USB Driver warning";
-      AndroidMode.showMessage(title, text, 400, 100); 
+      AndroidMode.showMessage(USB_DRIVER_TITLE, text);
     } else {
       new Thread() {
         public void run() {
diff --git a/src/processing/mode/android/AndroidMode.java b/src/processing/mode/android/AndroidMode.java
@@ -36,11 +36,6 @@
 import processing.mode.android.AndroidSDK.CancelException;
 import processing.mode.java.JavaMode;
 
-import java.awt.Container;
-import java.awt.Dimension;
-import java.awt.FlowLayout;
-import java.awt.event.MouseAdapter;
-import java.awt.event.MouseEvent;
 import java.io.BufferedInputStream;
 import java.io.BufferedOutputStream;
 import java.io.File;
@@ -54,10 +49,11 @@
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
 
-import javax.swing.JComponent;
-import javax.swing.JFrame;
+import javax.swing.JEditorPane;
 import javax.swing.JLabel;
 import javax.swing.JOptionPane;
+import javax.swing.event.HyperlinkEvent;
+import javax.swing.event.HyperlinkListener;
 
 
 public class AndroidMode extends JavaMode {
@@ -71,6 +67,28 @@ public class AndroidMode extends JavaMode {
   private boolean checkingSDK = false;
   private boolean userCancelledSDKSearch = false;
 
+  private static final String BLUETOOTH_DEBUG_URL = 
+      "http://developer.android.com/training/wearables/apps/bt-debugging.html";
+  
+  private static final String WATCHFACE_DEBUG_TITLE =
+      "Is Debugging over Bluetooth enabled?";
+  
+  private static final String WATCHFACE_DEBUG_MESSAGE =
+      "Processing will access the smartwatch through the phone " +
+      "currently paired to it. Your watch won't show up in the device list, " +
+      "select the phone instead.<br><br>" +
+      "Make sure to enable <a href=\"" + BLUETOOTH_DEBUG_URL + "\">debugging over bluetooth</a> " +
+      "for this to work.";
+  
+  private static final String WALLPAPER_INSTALL_TITLE =
+      "Wallpaper installed!";
+  
+  private static final String WALLPAPER_INSTALL_MESSAGE = 
+      "Processing just built and installed your sketch as a " +
+      "live wallpaper on the selected device.<br><br>" +
+      "You need to open the wallpaper picker in the device in order "+ 
+      "to select it as the new background.";
+  
   public AndroidMode(Base base, File folder) {
     super(base, folder);
   }
@@ -326,38 +344,18 @@ public void handleRunDevice(Sketch sketch, AndroidEditor editor,
     showPostBuildMessage(build.getAppComponent());
   }
 
+  
   public void showSelectComponentMessage(int appComp) {
     if (showBluetoothDebugMessage && appComp == AndroidBuild.WATCHFACE) {
-      JLabel text1 = new JLabel("<html>Processing will access the watch through the phone<br>" +
-        "paired to it. Your watch won't show up in the device list,<br>"+
-        "select the paired phone.</html>");      
-      JLabel text2 = new JLabel("<html>Make sure to enable</html>");
-      final String url = "http://developer.android.com/training/wearables/apps/bt-debugging.html";
-      String urlText = "<html><a href=\"" + url + "\">debugging over bluetooth</a></html>";      
-      JLabel link = new JLabel(urlText);
-      link.setCursor(new java.awt.Cursor(java.awt.Cursor.HAND_CURSOR));
-      link.addMouseListener(new MouseAdapter() {
-        public void mouseClicked(MouseEvent e) {
-          Platform.openURL(url);
-        }
-      });
-      JLabel text3 = new JLabel("<html>for this to work.</html>");
-      JComponent[] text = new JComponent[] { text1, text2, link, text3 };  
-      String title = "Is Debugging over Bluetooth enabled?";
-      showMessage(title, text, 400, 100);
+      showMessage(WATCHFACE_DEBUG_TITLE, WATCHFACE_DEBUG_MESSAGE);
       showBluetoothDebugMessage = false;
     } 
   }
   
+  
   public void showPostBuildMessage(int appComp) {
     if (showWallpaperSelectMessage && appComp == AndroidBuild.WALLPAPER) {
-      JLabel text1 = new JLabel("<html>Processing just built and installed your sketch as a<br>" +
-          "live wallpaper on the selected device.<br><br>" +
-          "You need to open the wallpaper selector in the device in order<br>"+ 
-          "to set it as the new background.</html>");
-      JComponent[] text = new JComponent[] { text1 };
-      String title = "Wallpaper installed!";
-      showMessage(title, text, 400, 100);  
+      showMessage(WALLPAPER_INSTALL_TITLE, WALLPAPER_INSTALL_MESSAGE);  
       showWallpaperSelectMessage = false;
     }    
   }
@@ -467,22 +465,30 @@ public static void extractFolder(File file, File newPath,
     zip.close();
   }
 
-  // Based on some ideas seen in this thread 
-  // http://stackoverflow.com/questions/527719/how-to-add-hyperlink-in-jlabel
-  static public void showMessage(String title, JComponent[] text, 
-      int w, int h) {
+
+  static public void showMessage(String title, String text) {
     if (title == null) title = "Message";
-    if (Base.isCommandLine()) {
-      String concat = "";
-      for (JComponent txt: text) concat += txt.toString();
-      System.out.println(title + ": " + concat);
+    if (Base.isCommandLine()) {      
+      System.out.println(title + ": " + text);
     } else {
-      JFrame frame = new JFrame();
-      Container outer = frame.getContentPane();
-      outer.setLayout(new FlowLayout(FlowLayout.LEFT));
-      for (JComponent txt: text) outer.add(txt);
-      outer.setPreferredSize(new Dimension(w, h));      
-      JOptionPane.showMessageDialog(frame, outer, title,
+      String htmlString = "<html> " +
+          "<head> <style type=\"text/css\">"+
+          "p { font: 11pt \"Lucida Grande\"; margin-top: 8px; width: 300px }"+
+          "</style> </head>" +
+          "<body> <p>" + text + "</p> </body> </html>";      
+      JEditorPane pane = new JEditorPane("text/html", htmlString);
+      pane.addHyperlinkListener(new HyperlinkListener() {
+        @Override
+        public void hyperlinkUpdate(HyperlinkEvent e) {
+          if (e.getEventType().equals(HyperlinkEvent.EventType.ACTIVATED)) {
+            Platform.openURL(e.getURL().toString());
+          }
+        }
+      });
+      pane.setEditable(false);
+      JLabel label = new JLabel();
+      pane.setBackground(label.getBackground());      
+      JOptionPane.showMessageDialog(null, pane, title, 
           JOptionPane.INFORMATION_MESSAGE);
     }
   }   
diff --git a/src/processing/mode/android/AndroidSDK.java b/src/processing/mode/android/AndroidSDK.java
@@ -29,6 +29,9 @@
 import processing.core.PApplet;
 
 import javax.swing.*;
+import javax.swing.event.HyperlinkEvent;
+import javax.swing.event.HyperlinkListener;
+
 import java.awt.*;
 import java.io.BufferedReader;
 import java.io.File;
@@ -53,21 +56,36 @@ class AndroidSDK {
   private final File buildTools;
   private final File androidTool;
 
-  static final String DOWNLOAD_URL ="https://developer.android.com/studio/index.html#downloads";
+  private static final String SDK_DOWNLOAD_URL = 
+      "https://developer.android.com/studio/index.html#downloads";
   
-  private static final String ANDROID_SDK_PRIMARY =
+  private static final String MISSING_SDK_TITLE =
     "Is the Android SDK installed?";
-
-  private static final String ANDROID_SDK_SECONDARY =
-      "The Android SDK does not appear to be installed, <br>" +
-      "because the ANDROID_SDK variable is not set. <br>" +
-      "If it is installed, click “Locate SDK path” to select the <br>" +
-      "location of the SDK, or “Download SDK” to let <br>" +
+  
+  private static final String MISSING_SDK_MESSAGE =
+      "The Android SDK does not appear to be installed, " +
+      "because the ANDROID_SDK variable is not set. " +
+      "If it is installed, click “Locate SDK path” to select the" +
+      "location of the SDK, or “Download SDK” to let " +
       "Processing download the SDK automatically.<br><br>" +
-      "If you want to download the SDK manually, you can get <br>"+
-      "the command line tools from <a href=\"" + DOWNLOAD_URL + "\">here</a>. Make sure to install<br>" +
-      "the SDK platform for API " + AndroidBuild.target_sdk + ".";
+      "If you want to download the SDK manually, you can get "+
+      "the command line tools from <a href=\"" + SDK_DOWNLOAD_URL + "\">here</a>. " +
+      "Make sure to install the SDK platform for API " + AndroidBuild.target_sdk + ".";
     
+  private static final String INVALID_SDK_TITLE =
+      "Is the required Android API installed?";
+  
+  private static final String INVALID_SDK_MESSAGE =
+      "The Android SDK appears to be installed, " +
+      "however the SDK platform for API " + AndroidBuild.target_sdk + 
+      " was not found. If it is available in a different location, " +
+      "click “Locate SDK path” to select the " +
+      "location of the alternative SDK, or “Download SDK” to let " +
+      "Processing download the SDK automatically.<br><br>" +
+      "If you want to download the SDK manually, you can get "+
+      "the command line tools from <a href=\"" + SDK_DOWNLOAD_URL + "\">here</a>. " +
+      "Make sure to install the SDK platform for API " + AndroidBuild.target_sdk + ".";  
+  
   private static final String ANDROID_SYS_IMAGE_PRIMARY =
       "Download emulator?";
 
@@ -86,6 +104,11 @@ class AndroidSDK {
     
   private static final String SELECT_ANDROID_SDK_FOLDER =
     "Choose the location of the Android SDK";
+  
+  private static final int NO_ERROR = 0;
+  private static final int MISSING_SDK = 1;
+  private static final int INVALID_SDK = 2;
+  private static int SDK_LOAD_ERROR = NO_ERROR;
 
   public AndroidSDK(File folder) throws BadSDKException, IOException {
     this.folder = folder;
@@ -263,6 +286,8 @@ private static File findAndroidTool(final File tools) throws BadSDKException {
    * @throws IOException
    */
   public static AndroidSDK load() throws IOException {
+    SDK_LOAD_ERROR = NO_ERROR;
+    
     // The environment variable is king. The preferences.txt entry is a page.
     final String sdkEnvPath = Platform.getenv("ANDROID_SDK");
     if (sdkEnvPath != null) {
@@ -289,7 +314,10 @@ public static AndroidSDK load() throws IOException {
         return androidSDK;
       } catch (final BadSDKException wellThatsThat) {
         Preferences.unset("android.sdk.path");
+        SDK_LOAD_ERROR = INVALID_SDK;
       }
+    } else {
+      SDK_LOAD_ERROR = MISSING_SDK;
     }
     return null;
   }
@@ -359,36 +387,44 @@ static public boolean downloadSysImage(final Frame editor,
     return res;
   }
 
+  
   static public int showLocateDialog(Frame editor) {
-    // Pane formatting adapted from the Quaqua guide
-    // http://www.randelshofer.ch/quaqua/guide/joptionpane.html
-    JOptionPane pane =
-        new JOptionPane("<html> " +
-            "<head> <style type=\"text/css\">"+
-            "b { font: 13pt \"Lucida Grande\" }"+
-            "p { font: 11pt \"Lucida Grande\"; margin-top: 8px; width: 300px }"+
-            "</style> </head>" +
-            "<b>" + ANDROID_SDK_PRIMARY + "</b>" +
-            "<p>" + ANDROID_SDK_SECONDARY + "</p>",
-            JOptionPane.QUESTION_MESSAGE);
-
+    // How to show a option dialog containing clickable links:
+    // http://stackoverflow.com/questions/8348063/clickable-links-in-joptionpane
+    String htmlString = "<html> " +
+        "<head> <style type=\"text/css\">"+
+        "p { font: 11pt \"Lucida Grande\"; margin-top: 8px; width: 300px }"+
+        "</style> </head>";
+    String title = "";
+    if (SDK_LOAD_ERROR == MISSING_SDK) {
+      htmlString += "<body> <p>" + MISSING_SDK_MESSAGE + "</p> </body> </html>";
+      title = MISSING_SDK_TITLE;
+    } else if (SDK_LOAD_ERROR == INVALID_SDK) {
+      htmlString += "<body> <p>" + INVALID_SDK_MESSAGE + "</p> </body> </html>";
+      title = INVALID_SDK_TITLE;
+    }    
+    JEditorPane pane = new JEditorPane("text/html", htmlString);
+    pane.addHyperlinkListener(new HyperlinkListener() {
+      @Override
+      public void hyperlinkUpdate(HyperlinkEvent e) {
+        if (e.getEventType().equals(HyperlinkEvent.EventType.ACTIVATED)) {
+          Platform.openURL(e.getURL().toString());
+        }
+      }
+    });
+    pane.setEditable(false);
+    JLabel label = new JLabel();
+    pane.setBackground(label.getBackground());
+    
     String[] options = new String[] {
-        "Download SDK automatically", "Locate SDK path manually"
-    };
-    pane.setOptions(options);
-
-    // highlight the safest option ala apple hig
-    pane.setInitialValue(options[0]);
-
-    JDialog dialog = pane.createDialog(editor, null);
-    dialog.setTitle("");
-    dialog.setModalityType(Dialog.ModalityType.APPLICATION_MODAL);  
-    dialog.setVisible(true);
-
-    Object result = pane.getValue();
-    if (result == options[0]) {
+      "Download SDK automatically", "Locate SDK path manually"
+    };    
+    int result = JOptionPane.showOptionDialog(null, pane, title, 
+        JOptionPane.DEFAULT_OPTION, JOptionPane.QUESTION_MESSAGE, 
+        null, options, options[0]);
+    if (result == JOptionPane.YES_OPTION) {
       return JOptionPane.YES_OPTION;
-    } else if (result == options[1]) {
+    } else if (result == JOptionPane.NO_OPTION) {
       return JOptionPane.NO_OPTION;
     } else {
       return JOptionPane.CLOSED_OPTION;
