Merge commit 'alpha/update_2_12_for_2_11_2_series_merge^2' into HEAD
[jalview.git] / src / jalview / gui / SplashScreen.java
index 97de08a..fb12330 100755 (executable)
@@ -20,6 +20,7 @@
  */
 package jalview.gui;
 
+
 import java.awt.BorderLayout;
 import java.awt.Color;
 import java.awt.Component;
@@ -41,19 +42,26 @@ import javax.swing.event.HyperlinkListener;
 
 import jalview.util.ChannelProperties;
 import jalview.util.Platform;
-
 /**
  * DOCUMENT ME!
  * 
  * @author $author$
  * @version $Revision$
  */
+@SuppressWarnings("serial")
 public class SplashScreen extends JPanel
-        implements Runnable, HyperlinkListener
+        implements HyperlinkListener, StateMachine
 {
+  
+  private static final int STATE_INIT = 0;
+
+  private static final int STATE_LOOP = 1;
+
+  private static final int STATE_DONE = 2;
+
   private static final int SHOW_FOR_SECS = 5;
 
-  private static final int FONT_SIZE = 11;
+  private static final int FONT_SIZE = (Platform.isJS() ? 14 : 11);
 
   private boolean visible = true;
 
@@ -65,8 +73,6 @@ public class SplashScreen extends JPanel
 
   private static Color fg = Color.BLACK;
 
-  private static Font font = new Font("SansSerif", Font.PLAIN, FONT_SIZE);
-
   /*
    * as JTextPane in Java, JLabel in javascript
    */
@@ -80,8 +86,6 @@ public class SplashScreen extends JPanel
 
   private long oldTextLength = -1;
 
-  public static int logoSize = 32;
-
   /*
    * allow click in the initial splash screen to dismiss it
    * immediately (not if opened from About menu)
@@ -95,7 +99,6 @@ public class SplashScreen extends JPanel
       {
         try
         {
-          visible = false;
           closeSplash();
         } catch (Exception ex)
         {
@@ -107,240 +110,192 @@ public class SplashScreen extends JPanel
   /**
    * Constructor that displays the splash screen
    * 
-   * @param isTransient
+   * @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
+   *          if false it stays up until closed by the user (from Help..About menu)
    */
-  public SplashScreen(boolean isTransient)
+  public SplashScreen(boolean isStartup)
   {
-    this.transientDialog = isTransient;
+    this.transientDialog = 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 = ChannelProperties.getImage("banner");
+    logo = ChannelProperties.getImage("logo.48");
+    font = new Font("SansSerif", Font.PLAIN, FONT_SIZE);
+    helper = new StateHelper(this);
+    helper.next(STATE_INIT);
+  }
 
-    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();
-      }
-    }
+  protected void initSplashScreenWindow()
+  {
+    addMouseListener(closer);
+    waitForImages();
+    setLayout(new BorderLayout());
+    iframe = new JInternalFrame();
+    iframe.setFrameIcon(null);
+    iframe.setClosable(true);
+    iframe.setContentPane(this);
+    iframe.setLayer(JLayeredPane.PALETTE_LAYER);  
+    SplashImage splashimg = new SplashImage(image);
+    imgPanel.add(splashimg, BorderLayout.CENTER);
+    add(imgPanel, BorderLayout.NORTH);
+    Desktop.getDesktopPane().add(iframe);
+    refreshText();
   }
 
   /**
-   * ping the jalview version page then create and display the jalview
-   * splashscreen window.
+   * 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.
+   * 
    */
-  void initSplashScreenWindow()
+  private void waitForImages()
   {
-    addMouseListener(closer);
-
-    try
+    if (Platform.isJS())
+      return;
+    MediaTracker mt = new MediaTracker(this);
+    mt.addImage(image, 0);
+    mt.addImage(logo, 1);
+    do
     {
-      if (!Platform.isJS())
+      try
+      {
+        mt.waitForAll();
+      } catch (InterruptedException x)
       {
-        image = ChannelProperties.getImage("banner");
-        Image logo = ChannelProperties.getImage("logo.48");
-        MediaTracker mt = new MediaTracker(this);
-        if (image != null)
-        {
-          mt.addImage(image, 0);
-        }
-        if (logo != null)
-        {
-          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.setIconImages(ChannelProperties.getIconList());
       }
-    } catch (Exception ex)
+      if (mt.isErrorAny())
+      {
+        System.err.println("Error when loading images!");
+        break;
+      }
+    } while (!mt.checkAll());
+    if (logo != null)
     {
+      Desktop.getInstance().setIconImage(logo);
     }
-
     this.setBackground(bg);
     this.setForeground(fg);
     this.setFont(font);
+  }
 
-    iframe = new JInternalFrame();
-    iframe.setFrameIcon(null);
-    iframe.setClosable(true);
-    this.setLayout(new BorderLayout());
-    iframe.setContentPane(this);
-    iframe.setLayer(JLayeredPane.PALETTE_LAYER);
-    iframe.setBackground(bg);
-    iframe.setForeground(fg);
-    iframe.setFont(font);
-
-    if (Platform.isJS())
+  /**
+   * update text in author text panel reflecting current version information
+   */
+  protected boolean refreshText()
+  {
+    String newtext = Desktop.getInstance().getAboutMessage();
+    // System.err.println("Text found: \n"+newtext+"\nEnd of newtext.");
+    if (oldTextLength == newtext.length())
     {
-      // ignore in JavaScript
+      return false;
+    }
+  
+    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><img src=\""
+              + ChannelProperties.getImageURL("banner") + "\"/>" + newtext
+              + "<br></html>";
+      JLabel ta = new JLabel(text);
+      ta.setOpaque(true);
+      ta.setBackground(Color.white);
+      splashText = ta;
     }
     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);
+      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;
     }
-    add(splashText, BorderLayout.CENTER);
     splashText.addMouseListener(closer);
-    Desktop.desktop.add(iframe);
-    refreshText();
+
+    splashText.setVisible(true);
+    splashText.setSize(new Dimension(750,
+            375 + logoSize + (Platform.isJS() ? 40 : 0)));
+    splashText.setBackground(bg);
+    splashText.setForeground(fg);
+    splashText.setFont(font);
+    add(splashText, BorderLayout.CENTER);
+    revalidate();
+    int width = Math.max(splashText.getWidth(), iconimg.getWidth());
+    int height = splashText.getHeight() + iconimg.getHeight();
+    iframe.setBounds((iframe.getParent().getWidth() - width) / 2,
+            (iframe.getParent().getHeight() - height) / 2, 750,
+            width,height);
+    iframe.validate();
+    iframe.setVisible(true);
+    return true;
   }
 
-  /**
-   * update text in author text panel reflecting current version information
-   */
-  protected boolean refreshText()
+  protected void closeSplash()
   {
-    String newtext = Desktop.instance.getAboutMessage();
-    // System.err.println("Text found: \n"+newtext+"\nEnd of newtext.");
-    if (oldTextLength != newtext.length())
+    try
+    {
+
+      iframe.setClosed(true);
+    } catch (Exception ex)
     {
-      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><img src=\""
-                + ChannelProperties.getImageURL("banner") + "\"/>" + newtext
-                + "<br></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 + (Platform.isJS() ? 40 : 0)));
-      splashText.setBackground(bg);
-      splashText.setForeground(fg);
-      splashText.setFont(font);
-      add(splashText, BorderLayout.CENTER);
-      revalidate();
-      int width = Math.max(splashText.getWidth(), iconimg.getWidth());
-      int height = splashText.getHeight() + iconimg.getHeight();
-      iframe.setBounds(
-              Math.max(0, (Desktop.instance.getWidth() - width) / 2),
-              Math.max(0, (Desktop.instance.getHeight() - height) / 2),
-              width, height);
-      iframe.validate();
-      iframe.setVisible(true);
-      return true;
     }
-    return false;
   }
 
   /**
-   * 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
+      switch (helper.getState())
       {
-        Thread.sleep(500);
-      } catch (Exception ex)
-      {
-      }
-
-      if (transientDialog && ((System.currentTimeMillis() / 1000)
-              - startTime) > SHOW_FOR_SECS)
-      {
-        visible = false;
-      }
-
-      if (visible && refreshText())
-      {
-        iframe.repaint();
-      }
-      if (!transientDialog)
-      {
-        return;
+      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;
       }
     }
-
-    closeSplash();
-    Desktop.instance.startDialogQueue();
-  }
-
-  /**
-   * DOCUMENT ME!
-   */
-  public void closeSplash()
-  {
-    try
-    {
-
-      iframe.setClosed(true);
-    } catch (Exception ex)
-    {
-    }
   }
 
-  public class SplashImage extends JPanel
+  private class SplashImage extends JPanel
   {
     Image image;