X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FSplashScreen.java;h=83346fc923e6c74a350d3b5c4dbb88fe98f95c69;hb=7d602d0e4b439e56af3e4551ed71f181a8025534;hp=30503b1aa47564b59d82b9776e7acc2b18153fb5;hpb=2de8acfae59aced665e4c37ad0f7dcc2ed68818e;p=jalview.git diff --git a/src/jalview/gui/SplashScreen.java b/src/jalview/gui/SplashScreen.java index 30503b1..83346fc 100755 --- a/src/jalview/gui/SplashScreen.java +++ b/src/jalview/gui/SplashScreen.java @@ -1,26 +1,46 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1) - * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors * - * This program 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 2 - * of the License, or (at your option) any later version. + * This file is part of Jalview. * - * This program 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. + * 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 this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + * along with Jalview. If not, see . + * 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.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.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! @@ -28,109 +48,163 @@ import javax.swing.*; * @author $author$ * @version $Revision$ */ -public class SplashScreen extends JPanel implements Runnable +@SuppressWarnings("serial") +public class SplashScreen extends JPanel + implements HyperlinkListener, StateMachine { - boolean visible = true; + + private static final int STATE_INIT = 0; - JInternalFrame iframe; + private static final int STATE_LOOP = 1; - Image image; + private static final int STATE_DONE = 2; - int fontSize = 11; + private static final int SHOW_FOR_SECS = 5; - int yoffset = 30; + private int FONT_SIZE = (Platform.isJS() ? 14 : 11); - /** - * Creates a new SplashScreen object. - */ - public SplashScreen() - { - Thread t = new Thread(this); - t.start(); - } + private JPanel imgPanel = new JPanel(new BorderLayout()); - /** - * ping the jalview version page then create and display the jalview - * splashscreen window. + private JInternalFrame iframe; + + private Image image, logo; + + protected boolean isStartup = false; + + private long oldTextLength = -1; + + private StateHelper helper; + /* + * 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 (isStartup) { try { - visible = false; closeSplash(); } catch (Exception ex) { } } - }); - - try - { - java.net.URL url = getClass().getResource("/images/logo.gif"); - - if (url != null) - { - image = java.awt.Toolkit.getDefaultToolkit().createImage(url); - - MediaTracker mt = new MediaTracker(this); - mt.addImage(image, 0); - mt.waitForID(0); - Desktop.instance.setIconImage(image); - } - } catch (Exception ex) - { } + }; + + /** + * 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) + */ + public SplashScreen(boolean isStartup) + { + 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(false); + iframe.setClosable(true); iframe.setContentPane(this); - iframe.setLayer(JLayeredPane.PALETTE_LAYER); - - Desktop.desktop.add(iframe); - - iframe.setVisible(true); - iframe.setBounds((int) ((Desktop.instance.getWidth() - 750) / 2), - (int) ((Desktop.instance.getHeight() - 160) / 2), 750, 190); + iframe.setLayer(JLayeredPane.PALETTE_LAYER); + SplashImage splashimg = new SplashImage(image); + imgPanel.add(splashimg, BorderLayout.CENTER); + add(imgPanel, BorderLayout.NORTH); + Desktop.getDesktopPane().add(iframe); + refreshText(); } /** - * Create splash screen, display it and clear it off again. + * 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. + * */ - public void run() + private void waitForImages() { - initSplashScreenWindow(); - long startTime = System.currentTimeMillis() / 1000; - - while (visible) + 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 { try { - Thread.sleep(1000); - } catch (Exception ex) + mt.waitForAll(); + } catch (InterruptedException x) { } - - if (((System.currentTimeMillis() / 1000) - startTime) > 5) + if (mt.isErrorAny()) { - visible = false; + System.err.println("Error when loading images!"); + break; } - else - repaint(); + } while (!mt.checkAll()); + if (logo != null) + { + Desktop.getInstance().setIconImage(logo); } - - closeSplash(); } /** - * DOCUMENT ME! + * update text in author text panel reflecting current version information */ - public void closeSplash() + protected boolean refreshText() + { + String newtext = Desktop.getInstance().getAboutMessage(); + if (oldTextLength == newtext.length()) + { + return false; + } + oldTextLength = newtext.length(); + iframe.setVisible(false); + JTextPane jtp = new JTextPane(); + jtp.setEditable(false); + jtp.setContentType("text/html"); + jtp.setText("" + 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(); + 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; + } + + protected void closeSplash() { try { @@ -142,79 +216,84 @@ public class SplashScreen extends JPanel implements Runnable } /** - * DOCUMENT ME! + * 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. * - * @param g - * DOCUMENT ME! */ - public void paintComponent(Graphics g) + @Override + public boolean stateLoop() { - 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) + while (true) { - g.drawImage(image, 5, yoffset + 12, this); + 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; + } } + } - int y = yoffset; + private class SplashImage extends JPanel + { + Image image; - g.drawString("Jalview " + jalview.bin.Cache.getProperty("VERSION"), 50, - y); + public SplashImage(Image todisplay) + { + image = todisplay; + if (image != null) + { + setPreferredSize(new Dimension(image.getWidth(this) + 8, + image.getHeight(this))); + } + } - 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(Color.white); + g.fillRect(0, 0, getWidth(), getHeight()); + g.setColor(Color.black); + + 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 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: Andrew Waterhouse, Jim Procter, 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); } }