/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
- * Copyright (C) 2011 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ 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.
- *
+ * 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/>.
+ * 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.*;
-import java.awt.event.*;
-import javax.swing.*;
+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.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
+public class SplashScreen extends JPanel
+ implements Runnable, HyperlinkListener
{
- boolean visible = true;
+ private static final int SHOW_FOR_SECS = 5;
- JInternalFrame iframe;
+ private static final int FONT_SIZE = 11;
- Image image;
+ private boolean visible = true;
- int fontSize = 11;
+ private JPanel iconimg = new JPanel(new BorderLayout());
- int yoffset = 30;
+ // could change fg, bg, font later to use ChannelProperties (these are not
+ // actually being used!)
+ private static Color bg = Color.WHITE;
- /**
- * Creates a new SplashScreen object.
+ private static Color fg = Color.BLACK;
+
+ private static Font font = new Font("SansSerif", Font.PLAIN, FONT_SIZE);
+
+ /*
+ * as JTextPane in Java, JLabel in javascript
*/
- public SplashScreen()
- {
- Thread t = new Thread(this);
- t.start();
- }
+ private Component splashText;
- /**
- * ping the jalview version page then create and display the jalview
- * splashscreen window.
+ private JInternalFrame iframe;
+
+ private Image image;
+
+ private boolean transientDialog = false;
+
+ 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)
*/
- void initSplashScreenWindow()
+ private MouseAdapter closer = new MouseAdapter()
{
- addMouseListener(new MouseAdapter()
+ @Override
+ public void mousePressed(MouseEvent evt)
{
- public void mousePressed(MouseEvent evt)
+ if (transientDialog)
{
try
{
{
}
}
- });
+ }
+ };
- try
- {
- java.net.URL url = getClass().getResource("/images/logo.gif");
+ /**
+ * 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 (url != null)
+ if (Platform.isJS()) // BH 2019
+ {
+ splashText = new JLabel("");
+ run();
+ }
+ else
+ {
+ /**
+ * Java only
+ *
+ * @j2sIgnore
+ */
{
- image = java.awt.Toolkit.getDefaultToolkit().createImage(url);
+ 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
+ {
+ if (!Platform.isJS())
+ {
+ image = ChannelProperties.getImage("banner");
+ Image logo = ChannelProperties.getImage("logo.48");
MediaTracker mt = new MediaTracker(this);
- mt.addImage(image, 0);
- mt.waitForID(0);
- Desktop.instance.setIconImage(image);
+ 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)
{
}
+ this.setBackground(bg);
+ this.setForeground(fg);
+ this.setFont(font);
+
iframe = new JInternalFrame();
iframe.setFrameIcon(null);
- iframe.setClosable(false);
+ 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())
+ {
+ // 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();
+ }
+
+ /**
+ * update text in author text panel reflecting current version information
+ */
+ protected boolean refreshText()
+ {
+ String newtext = Desktop.instance.getAboutMessage();
+ // System.err.println("Text found: \n"+newtext+"\nEnd of newtext.");
+ 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><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);
- iframe.setVisible(true);
- iframe.setBounds((int) ((Desktop.instance.getWidth() - 750) / 2),
- (int) ((Desktop.instance.getHeight() - 160) / 2), 750, 190);
+ 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.
*/
+ @Override
public void run()
{
initSplashScreenWindow();
+
long startTime = System.currentTimeMillis() / 1000;
while (visible)
{
+ iframe.repaint();
try
{
- Thread.sleep(1000);
+ Thread.sleep(500);
} catch (Exception ex)
{
}
- if (((System.currentTimeMillis() / 1000) - startTime) > 5)
+ if (transientDialog && ((System.currentTimeMillis() / 1000)
+ - startTime) > SHOW_FOR_SECS)
{
visible = false;
}
- else
- repaint();
+
+ if (visible && refreshText())
+ {
+ iframe.repaint();
+ }
+ if (!transientDialog)
+ {
+ return;
+ }
}
closeSplash();
+ Desktop.instance.startDialogQueue();
}
/**
}
}
- /**
- * DOCUMENT ME!
- *
- * @param g
- * DOCUMENT ME!
- */
- public void paintComponent(Graphics g)
+ public class SplashImage 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));
+ Image image;
- if (image != null)
+ public SplashImage(Image todisplay)
{
- g.drawImage(image, 5, yoffset + 12, this);
+ image = todisplay;
+ if (image != null)
+ {
+ setPreferredSize(new Dimension(image.getWidth(this) + 8,
+ image.getHeight(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"))
+ @Override
+ public Dimension getPreferredSize()
{
- // 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);
+ return new Dimension(image.getWidth(this) + 8, image.getHeight(this));
}
- else if (!jalview.bin.Cache.getDefault("LATEST_VERSION", "Checking")
- .equals(jalview.bin.Cache.getProperty("VERSION")))
+
+ @Override
+ public void paintComponent(Graphics g)
{
- if (jalview.bin.Cache.getProperty("VERSION").toLowerCase()
- .indexOf("automated build") == -1)
+ g.setColor(bg);
+ g.fillRect(0, 0, getWidth(), getHeight());
+ g.setColor(fg);
+ g.setFont(new Font(font.getFontName(), Font.BOLD, FONT_SIZE + 6));
+
+ if (image != null)
{
- // Displayed when code version and jnlp version do not match and code
- // version is not a development build
- g.setColor(Color.red);
+ g.drawImage(image, (getWidth() - image.getWidth(this)) / 2,
+ (getHeight() - image.getHeight(this)) / 2, this);
}
- 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);
}
+ }
+
+ @Override
+ public void hyperlinkUpdate(HyperlinkEvent e)
+ {
+ Desktop.hyperlinkUpdate(e);
- 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);
}
}