X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FSplashScreen.java;h=4fb9136c55ef869f3b2ee3843817c18671ae876f;hb=02e2fe79e8c9c2e5e751c33cf6aec4ae25e3c993;hp=7f55f8b08c94597365cbd3d7f8b0d8119dd06643;hpb=10866cba33b339de23e5a4e3121ab86c08b5ff2a;p=jalview.git
diff --git a/src/jalview/gui/SplashScreen.java b/src/jalview/gui/SplashScreen.java
index 7f55f8b..4fb9136 100755
--- a/src/jalview/gui/SplashScreen.java
+++ b/src/jalview/gui/SplashScreen.java
@@ -1,48 +1,92 @@
/*
- * 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 .
+ * You should have received a copy of the GNU General Public License
+ * 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 jalview.util.Platform;
+
+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.Insets;
+import java.awt.MediaTracker;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.MouseAdapter;
+import java.awt.event.MouseEvent;
+import java.beans.PropertyVetoException;
-import javax.swing.*;
+import javax.swing.JInternalFrame;
+import javax.swing.JLabel;
+import javax.swing.JLayeredPane;
+import javax.swing.JPanel;
+import javax.swing.JTextPane;
+import javax.swing.Timer;
+import javax.swing.border.EmptyBorder;
import javax.swing.event.HyperlinkEvent;
import javax.swing.event.HyperlinkListener;
/**
- * DOCUMENT ME!
+ * A class that serves both as an initial 5-second splash screen (interactive
+ * false) as well as for the Help menu item action (interactive true).
+ *
+ * As a splash screen, the frame closes if clicked by the user.
+ *
+ * Closure loop converted from a while/sleep loop to a JavaScript-compatible
+ * state machine by Bob Hanson 2019.11.26.
+ *
+ * TODO: get JTextPane working for read-only HTML.
*
- * @author $author$
- * @version $Revision$
*/
-public class SplashScreen extends JPanel implements Runnable, HyperlinkListener
+@SuppressWarnings("serial")
+public class SplashScreen extends JPanel
+ implements Runnable, HyperlinkListener
{
- boolean visible = true;
+ private static final int STATE_INIT = 0;
- JPanel iconimg = new JPanel(new BorderLayout());
+ private static final int STATE_LOOP = 1;
+
+ private static final int STATE_DONE = 2;
+
+ // boolean visible = true;
+
+ private JPanel iconimg = new JPanel(new BorderLayout());
+
+ /**
+ * Temporary SwingJS Hack: Either a JLabel in JavaScript or a JTextPane in
+ * Java
+ */
+ protected Component htmlPane;
- JTextPane authlist = new JTextPane();
+ private JInternalFrame iframe;
- JInternalFrame iframe;
+ private Image image;
- Image image;
+ private final static int fontSize = 11;
- int fontSize = 11;
+ protected final static Font largeFont = new Font("Verdana", Font.BOLD,
+ fontSize + 6);
int yoffset = 30;
@@ -53,29 +97,32 @@ public class SplashScreen extends JPanel implements Runnable, HyperlinkListener
{
this(false);
}
- private boolean interactiveDialog=false;
+
+ protected boolean isInteractive = false;
+
/**
*
- * @param interactive if true - an internal dialog is opened rather than a free-floating splash screen
+ * @param interactive
+ * if true - an internal dialog is opened rather than a free-floating
+ * splash screen
*/
- public SplashScreen(boolean interactive)
+ public SplashScreen(boolean isInteractive)
{
- this.interactiveDialog=interactive;
- // show a splashscreen that will disapper
- Thread t = new Thread(this);
+ this.isInteractive = isInteractive;
+ Thread t = new Thread(this, "SplashScreen");
t.start();
}
-
MouseAdapter closer = new MouseAdapter()
{
+ @Override
public void mousePressed(MouseEvent evt)
{
try
{
- if (!interactiveDialog)
+ if (!isInteractive)
{
- visible = false;
+ setVisible(false);
closeSplash();
}
} catch (Exception ex)
@@ -88,79 +135,113 @@ public class SplashScreen extends JPanel implements Runnable, HyperlinkListener
* ping the jalview version page then create and display the jalview
* splashscreen window.
*/
- void initSplashScreenWindow()
+ protected 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);
+ MediaTracker mt = new MediaTracker(this);
+ mt.addImage(image, 0);
+ Image logo = (Platform.isJS() ? null
+ : java.awt.Toolkit.getDefaultToolkit().createImage(getClass()
+ .getResource("/images/Jalview_Logo_small.png")));
+ if (logo != 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);
+ }
+ do
+ {
+ try
+ {
+ mt.waitForAll();
+ } catch (InterruptedException x)
+ {
+ }
+ if (mt.isErrorAny())
+ {
+ System.err.println("Error when loading images!");
+ }
+ } while (!mt.checkAll());
+ if (url != null)
+ {
+ Desktop.getInstance().setIconImage(logo);
}
} catch (Exception ex)
{
}
-
iframe = new JInternalFrame();
iframe.setFrameIcon(null);
- iframe.setClosable(interactiveDialog);
+ iframe.setClosable(isInteractive);
this.setLayout(new BorderLayout());
iframe.setContentPane(this);
iframe.setLayer(JLayeredPane.PALETTE_LAYER);
-
- Desktop.desktop.add(iframe);
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.getDesktopPane().add(iframe);
refreshText();
}
- long oldtext = -1;
+ String oldtext;
+
+ private int mainState;
/**
* 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())
+ Desktop desktop = Desktop.getInstance();
+ String newtext = desktop.getAboutMessage(true).toString();
+ // System.err.println("Text found: \n"+newtext+"\nEnd of newtext.");
+ if (!newtext.equals(oldtext))
{
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);
+ oldtext = newtext;
+ if (Platform.isJS()) // BH 2019
+ {
+ // BH TODO SwingJS does not implement HTML style. Could rethink this.
+ if (htmlPane == null)
+ {
+ htmlPane = new JLabel();
+ }
+ JLabel l = (JLabel)htmlPane;
+ l.setText(newtext);
+ Font f = htmlPane.getFont();
+ l.setFont(new Font(f.getFamily(), Font.PLAIN, f.getSize()));
+ l.setBorder(new EmptyBorder(new Insets(5, 5, 5, 5)));
+ l.setOpaque(true);
+ l.setBackground(Color.white);
+ htmlPane = l;
+ }
+ else
+ /**
+ * Java only
+ *
+ * @j2sIgnore
+ */
+ {
+ if (htmlPane == null)
+ {
+ htmlPane = new JTextPane();
+ }
+ JTextPane pane = (JTextPane)htmlPane;
+ pane.setEditable(false);
+ pane.setContentType("text/html");
+ pane.setText(newtext);
+ pane.addHyperlinkListener(this);
+ htmlPane = pane;
+ }
+ htmlPane.addMouseListener(closer);
+ htmlPane.setSize(new Dimension(750, 375));
+ add(htmlPane, BorderLayout.CENTER);
+ int h = htmlPane.getHeight() + iconimg.getHeight();
+ iframe.setBounds(Math.max(0, (desktop.getWidth() - 750) / 2),
+ Math.max(0, (desktop.getHeight() - h) / 2), 750, h);
+ iframe.setVisible(true);
return true;
}
return false;
@@ -169,81 +250,120 @@ public class SplashScreen extends JPanel implements Runnable, HyperlinkListener
/**
* Create splash screen, display it and clear it off again.
*/
+ @Override
public void run()
{
- initSplashScreenWindow();
+ mainState = STATE_INIT;
+ mainLoop();
+ }
- long startTime = System.currentTimeMillis() / 1000;
+ protected long startTime;
- while (visible)
+ /**
+ * 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.
+ *
+ */
+ protected void mainLoop()
+ {
+ while (true)
{
- iframe.repaint();
- try
- {
- Thread.sleep(500);
- } catch (Exception ex)
+ switch (mainState)
{
- }
-
- if (!interactiveDialog && ((System.currentTimeMillis() / 1000) - startTime) > 5)
- {
- visible = false;
- }
+ case STATE_INIT:
+ initSplashScreenWindow();
+ startTime = System.currentTimeMillis() / 1000;
+ mainState = STATE_LOOP;
+ continue;
+ case STATE_LOOP:
+ if (!isVisible())
+ {
+ mainState = STATE_DONE;
+ continue;
+ }
+ if (!isInteractive
+ && ((System.currentTimeMillis() / 1000) - startTime) > 5)
+ {
+ setVisible(false);
+ continue;
+ }
+ if (isVisible() && refreshText())
+ {
+ iframe.repaint();
+ }
+ if (isInteractive)
+ {
+ return;
+ }
+ Timer timer = new Timer(500, new ActionListener()
+ {
+ @Override
+ public void actionPerformed(ActionEvent e)
+ {
+ mainLoop();
+ }
- if (visible && refreshText())
- {
-// if (interactiveDialog) {
- iframe.repaint();
-// } else {
-// iframe.repaint();
-// };
- }
- if (interactiveDialog)
- {
+ });
+ timer.setRepeats(false);
+ timer.start();
+ return;
+ case STATE_DONE:
+ closeSplash();
+ Desktop.getInstance().startDialogQueue();
return;
}
}
- closeSplash();
- Desktop.instance.startDialogQueue();
}
/**
- * DOCUMENT ME!
+ * Close the internal frame, either from the timer expiring or from the mouse
+ * action.
*/
public void closeSplash()
{
+ setVisible(false);
try
{
-
iframe.setClosed(true);
- } catch (Exception ex)
+ } catch (PropertyVetoException e)
{
}
}
- public class SplashImage extends JPanel
+ private class SplashImage extends JPanel
{
- Image image;
+ private 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.fillRect(0, 0, getWidth(), getHeight());
g.setColor(Color.black);
- g.setFont(new Font("Verdana", Font.BOLD, fontSize + 6));
+ g.setFont(largeFont);
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);
}
}
/*
@@ -287,10 +407,12 @@ public class SplashScreen extends JPanel implements Runnable, HyperlinkListener
* += fontSize + 4); }
*/
}
+
@Override
public void hyperlinkUpdate(HyperlinkEvent e)
{
Desktop.hyperlinkUpdate(e);
-
+
}
-}
\ No newline at end of file
+
+}