JAL-3274 resource path correction, code tidying (constants etc)
[jalview.git] / src / jalview / gui / SplashScreen.java
index 2b87e10..f4b275d 100755 (executable)
@@ -30,8 +30,10 @@ import java.awt.Font;
 import java.awt.Graphics;
 import java.awt.Image;
 import java.awt.MediaTracker;
+import java.awt.Toolkit;
 import java.awt.event.MouseAdapter;
 import java.awt.event.MouseEvent;
+import java.net.URL;
 
 import javax.swing.JInternalFrame;
 import javax.swing.JLabel;
@@ -50,82 +52,80 @@ import javax.swing.event.HyperlinkListener;
 public class SplashScreen extends JPanel
         implements Runnable, HyperlinkListener
 {
-  boolean visible = true;
+  private static final int SHOW_FOR_SECS = 5;
 
-  JPanel iconimg = new JPanel(new BorderLayout());
+  private static final int FONT_SIZE = 11;
 
-  /**
-   * either text area in javascript or in java text pane
+  private boolean visible = true;
+
+  private JPanel iconimg = new JPanel(new BorderLayout());
+
+  /*
+   * as JTextPane in Java, JLabel in javascript
    */
-  Component authlist;
+  private Component splashText;
 
-  JInternalFrame iframe;
+  private JInternalFrame iframe;
 
-  Image image;
+  private Image image;
 
-  int fontSize = 11;
+  private boolean transientDialog = false;
 
-  int yoffset = 30;
+  private long oldTextLength = -1;
 
-  /**
-   * Creates a new SplashScreen object.
+  /*
+   * allow click in the initial splash screen to dismiss it
+   * immediately (not if opened from About menu)
    */
-  public SplashScreen()
+  private MouseAdapter closer = new MouseAdapter()
   {
-    this(false);
-  }
-
-  private boolean interactiveDialog = false;
+    @Override
+    public void mousePressed(MouseEvent evt)
+    {
+      if (transientDialog)
+      {
+        try
+        {
+          visible = false;
+          closeSplash();
+        } catch (Exception ex)
+        {
+        }
+      }
+    }
+  };
 
   /**
+   * Constructor that displays the splash screen
    * 
-   * @param interactive
-   *          if true - an internal dialog is opened rather than a free-floating
-   *          splash screen
+   * @param isTransient
+   *          if true the panel removes itself on click or after a few seconds;
+   *          if false it stays up until closed by the user
    */
-  public SplashScreen(boolean interactive)
+  public SplashScreen(boolean isTransient)
   {
-    this.interactiveDialog = interactive;
-    // show a splashscreen that will disapper
+    this.transientDialog = isTransient;
+
     if (Platform.isJS()) // BH 2019
     {
-      authlist = new JLabel("");
+      splashText = new JLabel("");
       run();
     }
     else
     {
       /**
        * Java only
-       * 
+       *
        * @j2sIgnore
        */
       {
-        authlist = new JTextPane();
+        splashText = new JTextPane();
         Thread t = new Thread(this);
         t.start();
       }
     }
-
   }
 
-  MouseAdapter closer = new MouseAdapter()
-  {
-    @Override
-    public void mousePressed(MouseEvent evt)
-    {
-      try
-      {
-        if (!interactiveDialog)
-        {
-          visible = false;
-          closeSplash();
-        }
-      } catch (Exception ex)
-      {
-      }
-    }
-  };
-
   /**
    * ping the jalview version page then create and display the jalview
    * splashscreen window.
@@ -133,17 +133,17 @@ public class SplashScreen extends JPanel
   void initSplashScreenWindow()
   {
     addMouseListener(closer);
+
     try
     {
-      java.net.URL url = getClass().getResource("/images/Jalview_Logo.png");
-      java.net.URL urllogo = getClass()
+      URL url = getClass().getResource("/images/Jalview_Logo.png");
+      URL urllogo = getClass()
               .getResource("/images/Jalview_Logo_small.png");
 
       if (!Platform.isJS() && url != null)
       {
-        image = java.awt.Toolkit.getDefaultToolkit().createImage(url);
-        Image logo = java.awt.Toolkit.getDefaultToolkit()
-                .createImage(urllogo);
+        image = Toolkit.getDefaultToolkit().createImage(url);
+        Image logo = Toolkit.getDefaultToolkit().createImage(urllogo);
         MediaTracker mt = new MediaTracker(this);
         mt.addImage(image, 0);
         mt.addImage(logo, 1);
@@ -168,7 +168,7 @@ public class SplashScreen extends JPanel
 
     iframe = new JInternalFrame();
     iframe.setFrameIcon(null);
-    iframe.setClosable(interactiveDialog);
+    iframe.setClosable(true);
     this.setLayout(new BorderLayout());
     iframe.setContentPane(this);
     iframe.setLayer(JLayeredPane.PALETTE_LAYER);
@@ -183,62 +183,65 @@ public class SplashScreen extends JPanel
      * @j2sIgnore
      */
     {
-      ((JTextPane) authlist).setEditable(false);
+      ((JTextPane) splashText).setEditable(false);
 
       SplashImage splashimg = new SplashImage(image);
       iconimg.add(splashimg, BorderLayout.CENTER);
       add(iconimg, BorderLayout.NORTH);
     }
-    add(authlist, BorderLayout.CENTER);
-    authlist.addMouseListener(closer);
+    add(splashText, BorderLayout.CENTER);
+    splashText.addMouseListener(closer);
     Desktop.desktop.add(iframe);
     refreshText();
   }
 
-  long oldtext = -1;
-
   /**
    * update text in author text panel reflecting current version information
    */
-  @SuppressWarnings("unused")
   protected boolean refreshText()
   {
-    String newtext = Desktop.instance.getAboutMessage(true).toString();
+    String newtext = Desktop.instance.getAboutMessage();
     // System.err.println("Text found: \n"+newtext+"\nEnd of newtext.");
-    if (oldtext != newtext.length())
+    if (oldTextLength != newtext.length())
     {
       iframe.setVisible(false);
-      oldtext = newtext.length();
+      oldTextLength = newtext.length();
       if (Platform.isJS()) // BH 2019
       {
-        authlist = new JLabel(
-                "<html><br/><br/><img src=\"swingjs/j2s/images/Jalview_Logo.png\"/><br/>"
-                        + newtext);
-        ((JLabel) authlist).setOpaque(true);
-        ((JLabel) authlist).setBackground(Color.white);
+        /*
+         * SwingJS doesn't have HTMLEditorKit, required for a JTextPane
+         * to display formatted html, so we use a simple alternative
+         */
+        String text = "<html><br><br><img src=\"swingjs/j2s/images/Jalview_Logo.png\"/><br>"
+                + newtext + "</html>";
+        JLabel ta = new JLabel(text);
+        ta.setOpaque(true);
+        ta.setBackground(Color.white);
+        splashText = ta;
       }
       else
       /**
        * Java only
-       * 
+       *
        * @j2sIgnore
        */
       {
-        authlist = new JTextPane();
-        ((JTextPane) authlist).setEditable(false);
-        ((JTextPane) authlist).setContentType("text/html");
-        ((JTextPane) authlist).setText(newtext);
-        ((JTextPane) authlist).addHyperlinkListener(this);
+        JTextPane jtp = new JTextPane();
+        jtp.setEditable(false);
+        jtp.setContentType("text/html");
+        jtp.setText("<html>" + newtext + "</html>");
+        jtp.addHyperlinkListener(this);
+        splashText = jtp;
       }
-      authlist.addMouseListener(closer);
+      splashText.addMouseListener(closer);
 
-      authlist.setVisible(true);
-      authlist.setSize(new Dimension(750, 375));
-      add(authlist, BorderLayout.CENTER);
+      splashText.setVisible(true);
+      splashText.setSize(new Dimension(750, 375));
+      add(splashText, BorderLayout.CENTER);
       revalidate();
       iframe.setBounds((Desktop.instance.getWidth() - 750) / 2,
               (Desktop.instance.getHeight() - 375) / 2, 750,
-              authlist.getHeight() + iconimg.getHeight());
+              splashText.getHeight() + iconimg.getHeight());
       iframe.validate();
       iframe.setVisible(true);
       return true;
@@ -266,21 +269,17 @@ public class SplashScreen extends JPanel
       {
       }
 
-      if (!interactiveDialog
-              && ((System.currentTimeMillis() / 1000) - startTime) > 5)
+      if (transientDialog
+              && ((System.currentTimeMillis() / 1000) - startTime) > SHOW_FOR_SECS)
       {
         visible = false;
       }
 
       if (visible && refreshText())
       {
-        // if (interactiveDialog) {
         iframe.repaint();
-        // } else {
-        // iframe.repaint();
-        // };
       }
-      if (interactiveDialog)
+      if (!transientDialog)
       {
         return;
       }
@@ -330,7 +329,7 @@ public class SplashScreen extends JPanel
       g.setColor(Color.white);
       g.fillRect(0, 0, getWidth(), getHeight());
       g.setColor(Color.black);
-      g.setFont(new Font("Verdana", Font.BOLD, fontSize + 6));
+      g.setFont(new Font("Verdana", Font.BOLD, FONT_SIZE + 6));
 
       if (image != null)
       {
@@ -338,46 +337,6 @@ public class SplashScreen extends JPanel
                 (getHeight() - image.getHeight(this)) / 2, this);
       }
     }
-    /*
-     * int y = yoffset;
-     * 
-     * g.drawString("Jalview " + jalview.bin.Cache.getProperty("VERSION"), 50,
-     * y);
-     * 
-     * FontMetrics fm = g.getFontMetrics(); int vwidth =
-     * fm.stringWidth("Jalview " + jalview.bin.Cache.getProperty("VERSION"));
-     * g.setFont(new Font("Verdana", Font.BOLD, fontSize + 2)); g.drawString(
-     * "Last updated: " + jalview.bin.Cache.getDefault("BUILD_DATE", "unknown"),
-     * 50 + vwidth + 5, y); if (jalview.bin.Cache.getDefault("LATEST_VERSION",
-     * "Checking").equals( "Checking")) { // Displayed when code version and
-     * jnlp version do not match g.drawString("...Checking latest version...",
-     * 50, y += fontSize + 10); y += 5; g.setColor(Color.black); } else if
-     * (!jalview.bin.Cache.getDefault("LATEST_VERSION", "Checking")
-     * .equals(jalview.bin.Cache.getProperty("VERSION"))) { if
-     * (jalview.bin.Cache.getProperty("VERSION").toLowerCase()
-     * .indexOf("automated build") == -1) { // Displayed when code version and
-     * jnlp version do not match and code // version is not a development build
-     * g.setColor(Color.red); } g.drawString( "!! Jalview version " +
-     * jalview.bin.Cache.getDefault("LATEST_VERSION", "..Checking..") +
-     * " is available for download from "
-     * +jalview.bin.Cache.getDefault("www.jalview.org"
-     * ,"http://www.jalview.org")+" !!", 50, y += fontSize + 10); y += 5;
-     * g.setColor(Color.black); }
-     * 
-     * g.setFont(new Font("Verdana", Font.BOLD, fontSize)); g.drawString(
-     * "Authors: Jim Procter, Andrew Waterhouse, Michele Clamp, James Cuff, Steve Searle,"
-     * , 50, y += fontSize + 4); g.drawString("David Martin & Geoff Barton.",
-     * 60, y += fontSize + 4); g.drawString(
-     * "Development managed by The Barton Group, University of Dundee.", 50, y
-     * += fontSize + 4); g.drawString("If  you use Jalview, please cite: ", 50,
-     * y += fontSize + 4); g.drawString(
-     * "Waterhouse, A.M., Procter, J.B., Martin, D.M.A, Clamp, M. and Barton, G. J. (2009)"
-     * , 50, y += fontSize + 4); g.drawString(
-     * "Jalview Version 2 - a multiple sequence alignment editor and analysis workbench"
-     * , 50, y += fontSize + 4);
-     * g.drawString("Bioinformatics doi: 10.1093/bioinformatics/btp033", 50, y
-     * += fontSize + 4); }
-     */
   }
 
   @Override