JAL-3594 Images for splash screen
[jalview.git] / src / jalview / gui / SplashScreen.java
index 76565ce..a8a849e 100755 (executable)
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
- * Copyright (C) 2014 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
@@ -22,6 +22,7 @@ package jalview.gui;
 
 import java.awt.BorderLayout;
 import java.awt.Color;
+import java.awt.Component;
 import java.awt.Dimension;
 import java.awt.Font;
 import java.awt.Graphics;
@@ -31,97 +32,134 @@ import java.awt.event.MouseAdapter;
 import java.awt.event.MouseEvent;
 
 import javax.swing.JInternalFrame;
+import javax.swing.JLabel;
 import javax.swing.JLayeredPane;
 import javax.swing.JPanel;
 import javax.swing.JTextPane;
 import javax.swing.event.HyperlinkEvent;
 import javax.swing.event.HyperlinkListener;
 
+import jalview.util.ChannelProperties;
+import jalview.util.Platform;
+
 /**
  * DOCUMENT ME!
  * 
  * @author $author$
  * @version $Revision$
  */
-public class SplashScreen extends JPanel implements Runnable,
-        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;
 
-  JTextPane authlist = new JTextPane();
+  private boolean visible = true;
 
-  JInternalFrame iframe;
+  private JPanel iconimg = new JPanel(new BorderLayout());
 
-  Image image;
+  // could change fg, bg, font later to use ChannelProperties
+  private static Color bg = Color.WHITE;
 
-  int fontSize = 11;
+  private static Color fg = Color.BLACK;
 
-  int yoffset = 30;
+  private static Font font = new Font("SansSerif", Font.PLAIN, FONT_SIZE);
 
-  /**
-   * Creates a new SplashScreen object.
+  /*
+   * as JTextPane in Java, JLabel in javascript
    */
-  public SplashScreen()
-  {
-    this(false);
-  }
+  private Component splashText;
 
-  private boolean interactiveDialog = false;
+  private JInternalFrame iframe;
 
-  /**
-   * 
-   * @param interactive
-   *          if true - an internal dialog is opened rather than a free-floating
-   *          splash screen
-   */
-  public SplashScreen(boolean interactive)
-  {
-    this.interactiveDialog = interactive;
-    // show a splashscreen that will disapper
-    Thread t = new Thread(this);
-    t.start();
-  }
+  private Image image;
+
+  private boolean transientDialog = false;
+
+  private long oldTextLength = -1;
+
+  public static int logoSize = 32;
 
-  MouseAdapter closer = new MouseAdapter()
+  /*
+   * allow click in the initial splash screen to dismiss it
+   * immediately (not if opened from About menu)
+   */
+  private MouseAdapter closer = new MouseAdapter()
   {
+    @Override
     public void mousePressed(MouseEvent evt)
     {
-      try
+      if (transientDialog)
       {
-        if (!interactiveDialog)
+        try
         {
           visible = false;
           closeSplash();
+        } catch (Exception ex)
+        {
         }
-      } catch (Exception ex)
-      {
       }
     }
   };
 
   /**
+   * Constructor that displays the 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 isTransient)
+  {
+    this.transientDialog = isTransient;
+
+    if (Platform.isJS()) // BH 2019
+    {
+      splashText = new JLabel("");
+      run();
+    }
+    else
+    {
+      /**
+       * Java only
+       *
+       * @j2sIgnore
+       */
+      {
+        splashText = new JTextPane();
+        splashText.setBackground(bg);
+        splashText.setForeground(fg);
+        splashText.setFont(font);
+        Thread t = new Thread(this);
+        t.start();
+      }
+    }
+  }
+
+  /**
    * ping the jalview version page then create and display the jalview
    * splashscreen window.
    */
   void initSplashScreenWindow()
   {
     addMouseListener(closer);
+
     try
     {
-      java.net.URL url = getClass().getResource("/images/Jalview_Logo.png");
-      java.net.URL urllogo = getClass().getResource(
-              "/images/Jalview_Logo_small.png");
-
-      if (url != null)
+      if (!Platform.isJS())
       {
-        image = java.awt.Toolkit.getDefaultToolkit().createImage(url);
-        Image logo = java.awt.Toolkit.getDefaultToolkit().createImage(
-                urllogo);
+        image = ChannelProperties.getImage("banner");
+        Image logo = ChannelProperties.getImage("logo.48");
         MediaTracker mt = new MediaTracker(this);
-        mt.addImage(image, 0);
-        mt.addImage(logo, 1);
+        if (image != null)
+        {
+          mt.addImage(image, 0);
+        }
+        if (logo != null)
+        {
+          mt.addImage(logo, 1);
+        }
         do
         {
           try
@@ -130,64 +168,113 @@ public class SplashScreen extends JPanel implements Runnable,
           } catch (InterruptedException x)
           {
           }
-          ;
           if (mt.isErrorAny())
           {
             System.err.println("Error when loading images!");
           }
         } while (!mt.checkAll());
-        Desktop.instance.setIconImage(logo);
+        Desktop.instance.setIconImages(ChannelProperties.getIconList());
       }
     } catch (Exception ex)
     {
     }
 
+    this.setBackground(bg);
+    this.setForeground(fg);
+    this.setFont(font);
+
     iframe = new JInternalFrame();
     iframe.setFrameIcon(null);
-    iframe.setClosable(interactiveDialog);
+    iframe.setClosable(true);
     this.setLayout(new BorderLayout());
     iframe.setContentPane(this);
     iframe.setLayer(JLayeredPane.PALETTE_LAYER);
+    iframe.setBackground(bg);
+    iframe.setForeground(fg);
+    iframe.setFont(font);
 
-    SplashImage splashimg = new SplashImage(image);
-    iconimg.add(splashimg, BorderLayout.CENTER);
-    add(iconimg, BorderLayout.NORTH);
-    add(authlist, BorderLayout.CENTER);
-    authlist.setEditable(false);
-    authlist.addMouseListener(closer);
+    if (Platform.isJS())
+    {
+      // ignore in JavaScript
+    }
+    else
+    /**
+     * Java only
+     * 
+     * @j2sIgnore
+     */
+    {
+      ((JTextPane) splashText).setEditable(false);
+      splashText.setBackground(bg);
+      splashText.setForeground(fg);
+      splashText.setFont(font);
+
+      SplashImage splashimg = new SplashImage(image);
+      iconimg.add(splashimg, BorderLayout.LINE_START);
+      iconimg.setBackground(bg);
+      add(iconimg, BorderLayout.NORTH);
+    }
+    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
    */
   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();
-      authlist = new JTextPane();
-      authlist.setEditable(false);
-      authlist.addMouseListener(closer);
-      authlist.addHyperlinkListener(this);
-      authlist.setContentType("text/html");
-      authlist.setText(newtext);
-      authlist.setVisible(true);
-      authlist.setSize(new Dimension(750, 375));
-      add(authlist, BorderLayout.CENTER);
+      oldTextLength = newtext.length();
+      if (Platform.isJS()) // BH 2019
+      {
+        /*
+         * 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-48.png\"/><br>"
+                + newtext + "</html>";
+        JLabel ta = new JLabel(text);
+        ta.setOpaque(true);
+        ta.setBackground(Color.white);
+        splashText = ta;
+      }
+      else
+      /**
+       * Java only
+       *
+       * @j2sIgnore
+       */
+      {
+        JTextPane jtp = new JTextPane();
+        jtp.setEditable(false);
+        jtp.setBackground(bg);
+        jtp.setForeground(fg);
+        jtp.setFont(font);
+        jtp.setContentType("text/html");
+        jtp.setText("<html>" + newtext + "</html>");
+        jtp.addHyperlinkListener(this);
+        splashText = jtp;
+      }
+      splashText.addMouseListener(closer);
+
+      splashText.setVisible(true);
+      splashText.setSize(new Dimension(750, 375 + logoSize));
+      splashText.setBackground(bg);
+      splashText.setForeground(fg);
+      splashText.setFont(font);
+      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;
     }
     return false;
@@ -196,6 +283,7 @@ public class SplashScreen extends JPanel implements Runnable,
   /**
    * Create splash screen, display it and clear it off again.
    */
+  @Override
   public void run()
   {
     initSplashScreenWindow();
@@ -212,21 +300,17 @@ public class SplashScreen extends JPanel implements Runnable,
       {
       }
 
-      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;
       }
@@ -257,8 +341,11 @@ public class SplashScreen extends JPanel implements Runnable,
     public SplashImage(Image todisplay)
     {
       image = todisplay;
-      setPreferredSize(new Dimension(image.getWidth(this) + 8,
-              image.getHeight(this)));
+      if (image != null)
+      {
+        setPreferredSize(new Dimension(image.getWidth(this) + 8,
+                image.getHeight(this)));
+      }
     }
 
     @Override
@@ -267,12 +354,13 @@ public class SplashScreen extends JPanel implements Runnable,
       return new Dimension(image.getWidth(this) + 8, image.getHeight(this));
     }
 
+    @Override
     public void paintComponent(Graphics g)
     {
-      g.setColor(Color.white);
+      g.setColor(bg);
       g.fillRect(0, 0, getWidth(), getHeight());
-      g.setColor(Color.black);
-      g.setFont(new Font("Verdana", Font.BOLD, fontSize + 6));
+      g.setColor(fg);
+      g.setFont(new Font(font.getFontName(), Font.BOLD, FONT_SIZE + 6));
 
       if (image != null)
       {
@@ -280,46 +368,6 @@ public class SplashScreen extends JPanel implements Runnable,
                 (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