JAL-3487 Splash screen

- JS now uses StateMachine

- simple example of how StateMachine works.

diff --git a/src/jalview/gui/SplashScreen.java b/src/jalview/gui/SplashScreen.java
index 0edede4..0def6e4 100755 (executable)
--- a/src/jalview/gui/SplashScreen.java
+++ b/src/jalview/gui/SplashScreen.java
@@ -20,11 +20,8 @@
  */
 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;
@@ -36,40 +33,44 @@ import java.awt.event.MouseEvent;
 import java.net.URL;
 
 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
 {
-  private static final int SHOW_FOR_SECS = 5;
+  
+  private static final int STATE_INIT = 0;
 
-  private static final int FONT_SIZE = 11;
+  private static final int STATE_LOOP = 1;
 
-  private boolean visible = true;
+  private static final int STATE_DONE = 2;
 
-  private JPanel iconimg = new JPanel(new BorderLayout());
+  private static final int SHOW_FOR_SECS = 5;
 
-  /*
-   * as JTextPane in Java, JLabel in javascript
-   */
-  private Component splashText;
+  private int FONT_SIZE = (Platform.isJS() ? 14 : 11);
+
+  private JPanel imgPanel = new JPanel(new BorderLayout());
 
   private JInternalFrame iframe;
 
   private Image image;
 
-  private boolean transientDialog = false;
+  protected boolean isInteractive = false;
 
   private long oldTextLength = -1;
 
@@ -82,11 +83,10 @@ public class SplashScreen extends JPanel
     @Override
     public void mousePressed(MouseEvent evt)
     {
-      if (transientDialog)
+      if (isInteractive)
       {
         try
         {
-          visible = false;
           closeSplash();
         } catch (Exception ex)
         {
@@ -95,6 +95,10 @@ public class SplashScreen extends JPanel
     }
   };
 
+  private Image logo;
+
+  private StateHelper helper;
+
   /**
    * Constructor that displays the splash screen
    * 
@@ -104,26 +108,21 @@ public class SplashScreen extends JPanel
    */
   public SplashScreen(boolean isTransient)
   {
-    this.transientDialog = isTransient;
+    this.isInteractive = isTransient;
 
-    if (Platform.isJS()) // BH 2019
-    {
-      splashText = new JLabel("");
-      run();
-    }
-    else
-    {
-      /**
-       * Java only
-       *
-       * @j2sIgnore
-       */
-      {
-        splashText = new JTextPane();
-        Thread t = new Thread(this);
-        t.start();
-      }
-    }
+    getImages();
+    helper = new StateHelper(this);
+    helper.next(STATE_INIT);
+  }
+
+  private void getImages()
+  {
+    URL url = getClass().getResource("/images/Jalview_Logo.png");
+    URL urllogo = getClass()
+            .getResource("/images/Jalview_Logo_small.png");
+    image = Toolkit.getDefaultToolkit().createImage(url);
+    if (!Platform.isJS())
+      logo = Toolkit.getDefaultToolkit().createImage(urllogo);
   }
 
   /**
@@ -136,61 +135,42 @@ public class SplashScreen extends JPanel
 
     try
     {
-      URL url = getClass().getResource("/images/Jalview_Logo.png");
-      URL urllogo = getClass()
-              .getResource("/images/Jalview_Logo_small.png");
-
-      if (!Platform.isJS() && url != null)
+      MediaTracker mt = new MediaTracker(this);
+      mt.addImage(image, 0);
+      if (logo != null)
       {
-        image = Toolkit.getDefaultToolkit().createImage(url);
-        Image logo = Toolkit.getDefaultToolkit().createImage(urllogo);
-        MediaTracker mt = new MediaTracker(this);
-        mt.addImage(image, 0);
         mt.addImage(logo, 1);
-        do
+      }
+      do
+      {
+        try
         {
-          try
-          {
-            mt.waitForAll();
-          } catch (InterruptedException x)
-          {
-          }
-          if (mt.isErrorAny())
-          {
-            System.err.println("Error when loading images!");
-          }
-        } while (!mt.checkAll());
+          mt.waitForAll();
+        } catch (InterruptedException x)
+        {
+        }
+        if (mt.isErrorAny())
+        {
+          System.err.println("Error when loading images!");
+        }
+      } while (!mt.checkAll());
+      if (logo != null)
+      {
         Desktop.getInstance().setIconImage(logo);
       }
     } catch (Exception ex)
     {
     }
-
     iframe = new JInternalFrame();
     iframe.setFrameIcon(null);
     iframe.setClosable(true);
     this.setLayout(new BorderLayout());
     iframe.setContentPane(this);
     iframe.setLayer(JLayeredPane.PALETTE_LAYER);
-    if (Platform.isJS())
-    {
-      // ignore in JavaScript
-    }
-    else
-    /**
-     * Java only
-     * 
-     * @j2sIgnore
-     */
-    {
-      ((JTextPane) splashText).setEditable(false);
-
-      SplashImage splashimg = new SplashImage(image);
-      iconimg.add(splashimg, BorderLayout.CENTER);
-      add(iconimg, BorderLayout.NORTH);
-    }
-    add(splashText, BorderLayout.CENTER);
-    splashText.addMouseListener(closer);
+    
+    SplashImage splashimg = new SplashImage(image);
+    imgPanel.add(splashimg, BorderLayout.CENTER);
+    add(imgPanel, BorderLayout.NORTH);
     Desktop.getDesktopPane().add(iframe);
     refreshText();
   }
@@ -201,97 +181,81 @@ public class SplashScreen extends JPanel
   protected boolean refreshText()
   {
     String newtext = Desktop.getInstance().getAboutMessage();
-    // System.err.println("Text found: \n"+newtext+"\nEnd of newtext.");
-    if (oldTextLength != newtext.length())
+    if (oldTextLength == newtext.length())
     {
-      iframe.setVisible(false);
-      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.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.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));
-      add(splashText, BorderLayout.CENTER);
-      revalidate();
-      iframe.setBounds((Desktop.getInstance().getWidth() - 750) / 2,
-              (Desktop.getInstance().getHeight() - 375) / 2, 750,
-              splashText.getHeight() + iconimg.getHeight());
-      iframe.validate();
-      iframe.setVisible(true);
-      return true;
+      return false;
     }
-    return false;
+    oldTextLength = newtext.length();
+    iframe.setVisible(false);
+    JTextPane jtp = new JTextPane();
+    jtp.setEditable(false);
+    jtp.setContentType("text/html");
+    jtp.setText("<html>" + newtext + "</html>");
+    
+    
+    System.out.println("Text found: \n"+newtext+"\nEnd of newtext.");
+    
+    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();
+    iframe.setBounds((Desktop.getInstance().getWidth() - 750) / 2,
+           50, 750,
+            jtp.getHeight() + imgPanel.getHeight());
+    iframe.validate();
+    iframe.setVisible(true);
+    return true;
   }
 
+  
+  protected long startTime;
+
   /**
-   * Create splash screen, display it and clear it off again.
+   * 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 void run()
+  public boolean stateLoop()
   {
-    initSplashScreenWindow();
-
-    long startTime = System.currentTimeMillis() / 1000;
-
-    while (visible)
+    while (true)
     {
-      iframe.repaint();
-      try
-      {
-        Thread.sleep(500);
-      } catch (Exception ex)
+      switch (helper.getState())
       {
-      }
-
-      if (transientDialog
-              && ((System.currentTimeMillis() / 1000) - startTime) > SHOW_FOR_SECS)
-      {
-        visible = false;
-      }
-
-      if (visible && refreshText())
-      {
-        iframe.repaint();
-      }
-      if (!transientDialog)
-      {
-        return;
+      case STATE_INIT:
+        initSplashScreenWindow();
+        startTime = System.currentTimeMillis() / 1000;
+        helper.setState(STATE_LOOP);
+        continue;
+      case STATE_LOOP:
+        if (!isVisible())
+        {
+          helper.setState(STATE_DONE);
+          continue;
+        }
+        if (refreshText())
+        {
+          iframe.repaint();
+        }
+        if (!isInteractive)
+        {
+          return false;
+        }
+        helper.delayedState(SHOW_FOR_SECS * 1000, STATE_DONE);
+        return true;
+      default:
+      case STATE_DONE:
+        setVisible(false);
+        closeSplash();
+        Desktop.getInstance().startDialogQueue();
+        return true;
       }
     }
-
-    closeSplash();
-    Desktop.getInstance().startDialogQueue();
   }
 
-  /**
-   * DOCUMENT ME!
-   */
   public void closeSplash()
   {
     try
@@ -329,7 +293,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, FONT_SIZE + 6));
 
       if (image != null)
       {