/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
- * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, 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, HyperlinkListener
+@SuppressWarnings("serial")
+public class SplashScreen extends JPanel
+ implements HyperlinkListener, StateMachine
{
- boolean visible = true;
+
+ private static final int STATE_INIT = 0;
- JPanel iconimg = new JPanel(new BorderLayout());
+ private static final int STATE_LOOP = 1;
- JTextPane authlist = new JTextPane();
+ private static final int STATE_DONE = 2;
- JInternalFrame iframe;
+ private static final int SHOW_FOR_SECS = 5;
- Image image;
+ private static final int FONT_SIZE = (Platform.isJS() ? 14 : 11);
- int fontSize = 11;
+ private boolean visible = true;
- int yoffset = 30;
+ private JPanel iconimg = new JPanel(new BorderLayout());
- /**
- * 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
+ // could change fg, bg, font later to use ChannelProperties (these are not
+ // actually being used!)
+ private static Color bg = Color.WHITE;
+
+ private static Color fg = Color.BLACK;
+
+ /*
+ * as JTextPane in Java, JLabel in javascript
*/
- public SplashScreen(boolean interactive)
- {
- this.interactiveDialog=interactive;
- // show a splashscreen that will disapper
- Thread t = new Thread(this);
- t.start();
- }
+ private Component splashText;
+ private JInternalFrame iframe;
- MouseAdapter closer = new MouseAdapter()
+ private Image image;
+
+ private boolean transientDialog = false;
+
+ private long oldTextLength = -1;
+
+ /*
+ * allow click in the initial splash screen to dismiss it
+ * immediately (not if opened from About menu)
+ */
+ private MouseAdapter closer = new MouseAdapter()
{
+ @Override
public void mousePressed(MouseEvent evt)
{
- try
+ if (transientDialog)
{
- if (!interactiveDialog)
+ try
{
- visible = false;
closeSplash();
+ } catch (Exception ex)
+ {
}
- } catch (Exception ex)
- {
}
}
};
/**
- * ping the jalview version page then create and display the jalview
- * splashscreen window.
+ * 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)
*/
- void initSplashScreenWindow()
+ public SplashScreen(boolean isStartup)
{
- addMouseListener(closer);
- try
- {
- java.net.URL url = getClass().getResource("/images/Jalviewlogo.png");
-
- 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)
- {
- }
+ 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);
+ }
+ protected void initSplashScreenWindow()
+ {
+ addMouseListener(closer);
+ waitForImages();
+ setLayout(new BorderLayout());
iframe = new JInternalFrame();
iframe.setFrameIcon(null);
- iframe.setClosable(interactiveDialog);
- this.setLayout(new BorderLayout());
+ iframe.setClosable(true);
iframe.setContentPane(this);
- iframe.setLayer(JLayeredPane.PALETTE_LAYER);
-
- Desktop.desktop.add(iframe);
+ 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);
+ imgPanel.add(splashimg, BorderLayout.CENTER);
+ add(imgPanel, BorderLayout.NORTH);
+ Desktop.getDesktopPane().add(iframe);
refreshText();
}
- long oldtext = -1;
-
/**
- * update text in author text panel reflecting current version information
+ * 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.
+ *
*/
- protected boolean refreshText()
+ private void waitForImages()
{
- String newtext = Desktop.instance.getAboutMessage(true).toString();
- //System.err.println("Text found: \n"+newtext+"\nEnd of newtext.");
- if (oldtext != newtext.length())
+ if (Platform.isJS())
+ return;
+ MediaTracker mt = new MediaTracker(this);
+ mt.addImage(image, 0);
+ mt.addImage(logo, 1);
+ do
{
- 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);
- add(authlist, BorderLayout.CENTER);
- iframe.setBounds((int) ((Desktop.instance.getWidth() - 750) / 2),
- (int) ((Desktop.instance.getHeight() - 160) / 2), 750,
- iframe.getPreferredSize().height);
- //System.err.println("New preferred size: "+iframe.getPreferredSize().height);
- 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())
+ mt.waitForAll();
+ } catch (InterruptedException x)
{
-// if (interactiveDialog) {
- iframe.repaint();
-// } else {
-// iframe.repaint();
-// };
}
- if (interactiveDialog)
+ if (mt.isErrorAny())
{
- return;
+ System.err.println("Error when loading images!");
+ break;
}
+ } while (!mt.checkAll());
+ if (logo != null)
+ {
+ Desktop.getInstance().setIconImage(logo);
}
-
- closeSplash();
+ this.setBackground(bg);
+ this.setForeground(fg);
+ this.setFont(font);
}
/**
- * DOCUMENT ME!
+ * update text in author text panel reflecting current version information
*/
- public void closeSplash()
+ protected boolean refreshText()
+ {
+ String newtext = Desktop.getInstance().getAboutMessage();
+ // System.err.println("Text found: \n"+newtext+"\nEnd of newtext.");
+ if (oldTextLength == newtext.length())
+ {
+ 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 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((iframe.getParent().getWidth() - width) / 2,
+ (iframe.getParent().getHeight() - height) / 2, 750,
+ width,height);
+ iframe.validate();
+ iframe.setVisible(true);
+ return true;
+ }
+
+ protected void closeSplash()
{
try
{
}
}
- public class SplashImage extends JPanel
+ /**
+ * 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 boolean stateLoop()
+ {
+ while (true)
+ {
+ 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;
+ }
+ }
+ }
+
+ private class SplashImage extends JPanel
{
Image image;
public SplashImage(Image todisplay)
{
image = todisplay;
- setPreferredSize(new Dimension(image.getWidth(this) + 8,
- image.getHeight(this)));
+ if (image != null)
+ {
+ setPreferredSize(new Dimension(image.getWidth(this) + 8,
+ image.getHeight(this)));
+ }
}
+ @Override
+ public Dimension getPreferredSize()
+ {
+ return new Dimension(image.getWidth(this) + 8, image.getHeight(this));
+ }
+
+ @Override
public void paintComponent(Graphics g)
{
- g.setColor(Color.white);
+ g.setColor(bg);
g.fillRect(0, 0, getWidth(), getHeight());
- g.setColor(Color.black);
- g.setFont(new Font("Verdana", Font.BOLD, fontSize + 6));
+ g.setColor(fg);
+ g.setFont(new Font(font.getFontName(), Font.BOLD, FONT_SIZE + 6));
if (image != null)
{
- g.drawImage(image, (getWidth() - image.getWidth(this)) / 2, (getHeight() - image.getHeight(this)) / 2,
- this);
+ 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);
-
+
}
-}
\ No newline at end of file
+}
git://source.jalview.org / jalview.git / blobdiff