X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FSplashScreen.java;h=83346fc923e6c74a350d3b5c4dbb88fe98f95c69;hb=0751c58086542f9e0466201b624f84d1efd547bb;hp=2b87e1063a63484fe224628f2005c800d03cb16a;hpb=577b0bf651763fe609eb6d6343754662023b3eac;p=jalview.git

diff --git a/src/jalview/gui/SplashScreen.java b/src/jalview/gui/SplashScreen.java
index 2b87e10..83346fc 100755
--- a/src/jalview/gui/SplashScreen.java
+++ b/src/jalview/gui/SplashScreen.java
@@ -20,280 +20,191 @@
  */
 package jalview.gui;
 
-import jalview.util.Platform;
-
 import java.awt.BorderLayout;
 import java.awt.Color;
-import java.awt.Component;
 import java.awt.Dimension;
 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 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.Platform;
+import javajs.async.SwingJSUtils.StateHelper;
+import javajs.async.SwingJSUtils.StateMachine;
+
 /**
  * DOCUMENT ME!
  * 
  * @author $author$
  * @version $Revision$
  */
+@SuppressWarnings("serial")
 public class SplashScreen extends JPanel
-        implements Runnable, HyperlinkListener
+        implements HyperlinkListener, StateMachine
 {
-  boolean visible = true;
+  
+  private static final int STATE_INIT = 0;
 
-  JPanel iconimg = new JPanel(new BorderLayout());
+  private static final int STATE_LOOP = 1;
 
-  /**
-   * either text area in javascript or in java text pane
-   */
-  Component authlist;
+  private static final int STATE_DONE = 2;
 
-  JInternalFrame iframe;
+  private static final int SHOW_FOR_SECS = 5;
 
-  Image image;
+  private int FONT_SIZE = (Platform.isJS() ? 14 : 11);
 
-  int fontSize = 11;
+  private JPanel imgPanel = new JPanel(new BorderLayout());
 
-  int yoffset = 30;
+  private JInternalFrame iframe;
 
-  /**
-   * Creates a new SplashScreen object.
-   */
-  public SplashScreen()
-  {
-    this(false);
-  }
+  private Image image, logo;
 
-  private boolean interactiveDialog = false;
+  protected boolean isStartup = false;
 
-  /**
-   * 
-   * @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
-    if (Platform.isJS()) // BH 2019
-    {
-      authlist = new JLabel("");
-      run();
-    }
-    else
-    {
-      /**
-       * Java only
-       * 
-       * @j2sIgnore
-       */
-      {
-        authlist = new JTextPane();
-        Thread t = new Thread(this);
-        t.start();
-      }
-    }
-
-  }
+  private long oldTextLength = -1;
 
-  MouseAdapter closer = new MouseAdapter()
+  private StateHelper helper;
+  /*
+   * 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 (isStartup)
       {
-        if (!interactiveDialog)
+        try
         {
-          visible = false;
           closeSplash();
+        } catch (Exception ex)
+        {
         }
-      } catch (Exception ex)
-      {
       }
     }
   };
 
   /**
-   * ping the jalview version page then create and display the jalview
-   * splashscreen window.
+   * Constructor that displays the splash screen
+   * 
+   * @param isStartup
+   *          if true the panel removes itself on click or after a few seconds;
+   *          if false it stays up until closed by the user (from Help..About menu)
    */
-  void initSplashScreenWindow()
+  public SplashScreen(boolean isStartup)
   {
-    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 (!Platform.isJS() && url != null)
-      {
-        image = java.awt.Toolkit.getDefaultToolkit().createImage(url);
-        Image logo = java.awt.Toolkit.getDefaultToolkit()
-                .createImage(urllogo);
-        MediaTracker mt = new MediaTracker(this);
-        mt.addImage(image, 0);
-        mt.addImage(logo, 1);
-        do
-        {
-          try
-          {
-            mt.waitForAll();
-          } catch (InterruptedException x)
-          {
-          }
-          if (mt.isErrorAny())
-          {
-            System.err.println("Error when loading images!");
-          }
-        } while (!mt.checkAll());
-        Desktop.instance.setIconImage(logo);
-      }
-    } catch (Exception ex)
-    {
-    }
+    this.isStartup = isStartup;
+    // we must get the image in JavaScript BEFORE starting the helper,
+    // as it will take a 1 ms clock tick to obtain width and height information.
+    image = Toolkit.getDefaultToolkit().createImage(
+            getClass().getResource("/images/Jalview_Logo.png"));
+    helper = new StateHelper(this);
+    helper.next(STATE_INIT);
+  }
 
+  protected void initSplashScreenWindow()
+  {
+    addMouseListener(closer);
+    waitForImages();
+    setLayout(new BorderLayout());
     iframe = new JInternalFrame();
     iframe.setFrameIcon(null);
-    iframe.setClosable(interactiveDialog);
-    this.setLayout(new BorderLayout());
+    iframe.setClosable(true);
     iframe.setContentPane(this);
-    iframe.setLayer(JLayeredPane.PALETTE_LAYER);
-    if (Platform.isJS())
-    {
-      // ignore in JavaScript
-    }
-    else
-    /**
-     * Java only
-     * 
-     * @j2sIgnore
-     */
-    {
-      ((JTextPane) authlist).setEditable(false);
-
-      SplashImage splashimg = new SplashImage(image);
-      iconimg.add(splashimg, BorderLayout.CENTER);
-      add(iconimg, BorderLayout.NORTH);
-    }
-    add(authlist, BorderLayout.CENTER);
-    authlist.addMouseListener(closer);
-    Desktop.desktop.add(iframe);
+    iframe.setLayer(JLayeredPane.PALETTE_LAYER);  
+    SplashImage splashimg = new SplashImage(image);
+    imgPanel.add(splashimg, BorderLayout.CENTER);
+    add(imgPanel, BorderLayout.NORTH);
+    Desktop.getDesktopPane().add(iframe);
     refreshText();
   }
 
-  long oldtext = -1;
-
   /**
-   * update text in author text panel reflecting current version information
+   * Both Java and JavaScript have to wait for images, but this method will
+   * accomplish nothing for JavaScript. We have already taken care of image
+   * loading with our state loop in JavaScript.
+   * 
    */
-  @SuppressWarnings("unused")
-  protected boolean refreshText()
+  private void waitForImages()
   {
-    String newtext = Desktop.instance.getAboutMessage(true).toString();
-    // System.err.println("Text found: \n"+newtext+"\nEnd of newtext.");
-    if (oldtext != newtext.length())
+    if (Platform.isJS())
+      return;
+    MediaTracker mt = new MediaTracker(this);
+    try
+    {
+      mt.addImage(image, 0);
+      logo = Toolkit.getDefaultToolkit().createImage(
+              getClass().getResource("/images/Jalview_Logo_small.png"));
+    } catch (Exception ex)
+    {
+    }
+    if (logo != null)
+    {
+      mt.addImage(logo, 1);
+    }
+    do
     {
-      iframe.setVisible(false);
-      oldtext = newtext.length();
-      if (Platform.isJS()) // BH 2019
+      try
+      {
+        mt.waitForAll();
+      } catch (InterruptedException x)
       {
-        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);
       }
-      else
-      /**
-       * Java only
-       * 
-       * @j2sIgnore
-       */
+      if (mt.isErrorAny())
       {
-        authlist = new JTextPane();
-        ((JTextPane) authlist).setEditable(false);
-        ((JTextPane) authlist).setContentType("text/html");
-        ((JTextPane) authlist).setText(newtext);
-        ((JTextPane) authlist).addHyperlinkListener(this);
+        System.err.println("Error when loading images!");
+        break;
       }
-      authlist.addMouseListener(closer);
-
-      authlist.setVisible(true);
-      authlist.setSize(new Dimension(750, 375));
-      add(authlist, BorderLayout.CENTER);
-      revalidate();
-      iframe.setBounds((Desktop.instance.getWidth() - 750) / 2,
-              (Desktop.instance.getHeight() - 375) / 2, 750,
-              authlist.getHeight() + iconimg.getHeight());
-      iframe.validate();
-      iframe.setVisible(true);
-      return true;
+    } while (!mt.checkAll());
+    if (logo != null)
+    {
+      Desktop.getInstance().setIconImage(logo);
     }
-    return false;
   }
 
   /**
-   * Create splash screen, display it and clear it off again.
+   * update text in author text panel reflecting current version information
    */
-  @Override
-  public void run()
+  protected boolean refreshText()
   {
-    initSplashScreenWindow();
-
-    long startTime = System.currentTimeMillis() / 1000;
-
-    while (visible)
+    String newtext = Desktop.getInstance().getAboutMessage();
+    if (oldTextLength == newtext.length())
     {
-      iframe.repaint();
-      try
-      {
-        Thread.sleep(500);
-      } catch (Exception ex)
-      {
-      }
-
-      if (!interactiveDialog
-              && ((System.currentTimeMillis() / 1000) - startTime) > 5)
-      {
-        visible = false;
-      }
-
-      if (visible && refreshText())
-      {
-        // if (interactiveDialog) {
-        iframe.repaint();
-        // } else {
-        // iframe.repaint();
-        // };
-      }
-      if (interactiveDialog)
-      {
-        return;
-      }
+      return false;
     }
-
-    closeSplash();
-    Desktop.instance.startDialogQueue();
+    oldTextLength = newtext.length();
+    iframe.setVisible(false);
+    JTextPane jtp = new JTextPane();
+    jtp.setEditable(false);
+    jtp.setContentType("text/html");
+    jtp.setText("<html>" + newtext + "</html>");
+    jtp.addHyperlinkListener(this);
+    jtp.setFont(new Font("Verdana", Font.PLAIN, FONT_SIZE));
+    jtp.addMouseListener(closer);
+    jtp.setVisible(true);
+    jtp.setSize(new Dimension(750, 425));
+    add(jtp, BorderLayout.CENTER);
+    revalidate();
+    int h = jtp.getHeight() + imgPanel.getHeight();
+    iframe.setBounds(Math.max(0, (iframe.getParent().getWidth() - 750) / 2),
+           Math.max(0,  (iframe.getParent().getHeight() - h)/2), 750, h);
+    iframe.validate();
+    iframe.setVisible(true);
+    return true;
   }
 
-  /**
-   * DOCUMENT ME!
-   */
-  public void closeSplash()
+  protected void closeSplash()
   {
     try
     {
@@ -304,7 +215,47 @@ public class SplashScreen extends JPanel
     }
   }
 
-  public class SplashImage extends JPanel
+  /**
+   * A simple state machine with just three states: init, loop, and done. Ideal
+   * for a simple while/sleep loop that works in Java and JavaScript
+   * identically.
+   * 
+   */
+  @Override
+  public boolean stateLoop()
+  {
+    while (true)
+    {
+      switch (helper.getState())
+      {
+      case STATE_INIT:
+        initSplashScreenWindow();
+        helper.setState(STATE_LOOP);
+        continue;
+      case STATE_LOOP:
+        if (!isVisible())
+        {
+          helper.setState(STATE_DONE);
+          continue;
+        }
+        if (refreshText())
+        {
+          iframe.repaint();
+        }
+        if (isStartup)
+          helper.delayedState(SHOW_FOR_SECS * 1000, STATE_DONE);
+        return true;
+      default:
+      case STATE_DONE:
+        setVisible(false);
+        closeSplash();
+        Desktop.getInstance().startDialogQueue();
+        return true;
+      }
+    }
+  }
+
+  private class SplashImage extends JPanel
   {
     Image image;
 
@@ -330,7 +281,6 @@ 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));
 
       if (image != null)
       {
@@ -338,46 +288,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