JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob
[jalview.git] / src / jalview / gui / SplashScreen.java
index 9481fd8..9c810d0 100755 (executable)
-/*\r
- * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
- *\r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
- */\r
-package jalview.gui;\r
-\r
-import java.awt.*;\r
-import java.awt.event.*;\r
-\r
-import javax.swing.*;\r
-\r
-\r
-/**\r
- * DOCUMENT ME!\r
- *\r
- * @author $author$\r
- * @version $Revision$\r
- */\r
-public class SplashScreen extends JPanel implements Runnable\r
-{\r
-    boolean visible = true;\r
-    JInternalFrame iframe;\r
-    Image image;\r
-    int fontSize = 11;\r
-    int yoffset = 30;\r
-\r
-    /**\r
-     * Creates a new SplashScreen object.\r
-     *\r
-     * @param iframe DOCUMENT ME!\r
-     * @param i DOCUMENT ME!\r
-     */\r
-    public SplashScreen(JInternalFrame iframe, Image i)\r
-    {\r
-        this.iframe = iframe;\r
-        image = i;\r
-\r
-        Thread t = new Thread(this);\r
-        t.start();\r
-        addMouseListener(new MouseAdapter()\r
-            {\r
-                public void mousePressed(MouseEvent evt)\r
-                {\r
-                    try\r
-                    {\r
-                        closeSplash();\r
-                    }\r
-                    catch (Exception ex)\r
-                    {\r
-                    }\r
-                }\r
-            });\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     */\r
-    public void run()\r
-    {\r
-        long startTime = System.currentTimeMillis() / 1000;\r
-\r
-        while (visible)\r
-        {\r
-            if (((System.currentTimeMillis() / 1000) - startTime) > 5)\r
-            {\r
-                visible = false;\r
-            }\r
-\r
-            try\r
-            {\r
-                Thread.sleep(1000);\r
-                repaint();\r
-            }\r
-            catch (Exception ex)\r
-            {\r
-            }\r
-        }\r
-\r
-        closeSplash();\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     */\r
-    public void closeSplash()\r
-    {\r
-        try\r
-        {\r
-            iframe.setClosed(true);\r
-            iframe=null;\r
-        }\r
-        catch (Exception ex)\r
-        {\r
-          ex.printStackTrace();\r
-        }\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param g DOCUMENT ME!\r
-     */\r
-    public void paintComponent(Graphics g)\r
-    {\r
-        g.setColor(Color.white);\r
-        g.fillRect(0, 0, getWidth(), getHeight());\r
-        g.setColor(Color.black);\r
-        g.setFont(new Font("Verdana", Font.BOLD, fontSize + 6));\r
-\r
-        if (image != null)\r
-        {\r
-            g.drawImage(image, 5, yoffset + 12, this);\r
-        }\r
-\r
-        int y = yoffset;\r
-\r
-        g.drawString("JalView 2005 ", 50, y);\r
-        g.setFont(new Font("Verdana", Font.BOLD, fontSize + 2));\r
-        g.drawString("Version " + jalview.bin.Cache.getProperty("VERSION") +\r
-                     "; Last updated: " + jalview.bin.Cache.getDefault("BUILD_DATE", "unknown"),\r
-                     180, y);\r
-\r
-        if (jalview.bin.Cache.getDefault("LATEST_VERSION", "Checking").equals("Checking"))\r
-        {\r
-          // Displayed when code version and jnlp version do not match\r
-          g.drawString("...Checking latest version...",\r
-                       50, y += fontSize + 10);\r
-          y += 5;\r
-          g.setColor(Color.black);\r
-        }\r
-        else if (!jalview.bin.Cache.getDefault("LATEST_VERSION", "Checking").equals(\r
-            jalview.bin.Cache.getProperty("VERSION")))\r
-        {\r
-          // Displayed when code version and jnlp version do not match\r
-          g.setColor(Color.red);\r
-          g.drawString("!! Jalview version " +\r
-                       jalview.bin.Cache.getDefault("LATEST_VERSION", "..Checking..")\r
-                       + " is available for download from http://www.jalview.org !!",\r
-                       50, y += fontSize + 10);\r
-          y += 5;\r
-          g.setColor(Color.black);\r
-        }\r
-\r
-        g.setFont(new Font("Verdana", Font.BOLD, fontSize));\r
-        g.drawString("Authors: Michele Clamp, James Cuff, Steve Searle, Andrew Waterhouse, Jim Procter & Geoff Barton.",\r
-            50, y+=fontSize+4);\r
-        g.drawString("Current development managed by Andrew Waterhouse; Barton Group, University of Dundee.",\r
-            50,  y+=fontSize+4);\r
-        g.drawString("If  you use JalView, please cite: Clamp, M., Cuff, J., Searle, S. M. and Barton, G. J. (2004),",\r
-            50, y+=fontSize+4);\r
-        g.drawString("\"The Jalview Java Alignment Editor\" Bioinformatics,  2004 12; 426-7.",\r
-            50, y+=fontSize+4);\r
-    }\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
+ * Copyright (C) 2015 The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.gui;
+
+import java.awt.BorderLayout;
+import java.awt.Color;
+import java.awt.Dimension;
+import java.awt.Font;
+import java.awt.Graphics;
+import java.awt.Image;
+import java.awt.MediaTracker;
+import java.awt.event.MouseAdapter;
+import java.awt.event.MouseEvent;
+
+import javax.swing.JInternalFrame;
+import javax.swing.JLayeredPane;
+import javax.swing.JPanel;
+import javax.swing.JTextPane;
+import javax.swing.event.HyperlinkEvent;
+import javax.swing.event.HyperlinkListener;
+
+/**
+ * DOCUMENT ME!
+ * 
+ * @author $author$
+ * @version $Revision$
+ */
+public class SplashScreen extends JPanel implements Runnable,
+        HyperlinkListener
+{
+  boolean visible = true;
+
+  JPanel iconimg = new JPanel(new BorderLayout());
+
+  JTextPane authlist = new JTextPane();
+
+  JInternalFrame iframe;
+
+  Image image;
+
+  int fontSize = 11;
+
+  int yoffset = 30;
+
+  /**
+   * Creates a new SplashScreen object.
+   */
+  public SplashScreen()
+  {
+    this(false);
+  }
+
+  private boolean interactiveDialog = 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
+    Thread t = new Thread(this);
+    t.start();
+  }
+
+  MouseAdapter closer = new MouseAdapter()
+  {
+    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.
+   */
+  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)
+      {
+        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)
+    {
+    }
+
+    iframe = new JInternalFrame();
+    iframe.setFrameIcon(null);
+    iframe.setClosable(interactiveDialog);
+    this.setLayout(new BorderLayout());
+    iframe.setContentPane(this);
+    iframe.setLayer(JLayeredPane.PALETTE_LAYER);
+
+    SplashImage splashimg = new SplashImage(image);
+    iconimg.add(splashimg, BorderLayout.CENTER);
+    add(iconimg, BorderLayout.NORTH);
+    add(authlist, BorderLayout.CENTER);
+    authlist.setEditable(false);
+    authlist.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();
+    // System.err.println("Text found: \n"+newtext+"\nEnd of newtext.");
+    if (oldtext != 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);
+      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;
+    }
+    return false;
+  }
+
+  /**
+   * Create splash screen, display it and clear it off again.
+   */
+  public void run()
+  {
+    initSplashScreenWindow();
+
+    long startTime = System.currentTimeMillis() / 1000;
+
+    while (visible)
+    {
+      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;
+      }
+    }
+
+    closeSplash();
+    Desktop.instance.startDialogQueue();
+  }
+
+  /**
+   * DOCUMENT ME!
+   */
+  public void closeSplash()
+  {
+    try
+    {
+
+      iframe.setClosed(true);
+    } catch (Exception ex)
+    {
+    }
+  }
+
+  public class SplashImage extends JPanel
+  {
+    Image image;
+
+    public SplashImage(Image todisplay)
+    {
+      image = todisplay;
+      setPreferredSize(new Dimension(image.getWidth(this) + 8,
+              image.getHeight(this)));
+    }
+
+    @Override
+    public Dimension getPreferredSize()
+    {
+      return new Dimension(image.getWidth(this) + 8, image.getHeight(this));
+    }
+
+    public void paintComponent(Graphics g)
+    {
+      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)
+      {
+        g.drawImage(image, (getWidth() - image.getWidth(this)) / 2,
+                (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
+  public void hyperlinkUpdate(HyperlinkEvent e)
+  {
+    Desktop.hyperlinkUpdate(e);
+
+  }
+}