From 7ce65b1fa2b76b09754d4128089c37b7208a356a Mon Sep 17 00:00:00 2001 From: BobHanson Date: Mon, 2 Dec 2019 10:16:57 -0600 Subject: [PATCH] JAL-3487 splash/help fix --- src/jalview/gui/SplashScreen.java | 299 ++++++++++++++++++++----------------- 1 file changed, 164 insertions(+), 135 deletions(-) diff --git a/src/jalview/gui/SplashScreen.java b/src/jalview/gui/SplashScreen.java index f5648d2..b6c31e1 100755 --- a/src/jalview/gui/SplashScreen.java +++ b/src/jalview/gui/SplashScreen.java @@ -29,41 +29,64 @@ 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.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$ */ +@SuppressWarnings("serial") public class SplashScreen extends JPanel implements Runnable, HyperlinkListener { - boolean visible = true; + private static final int STATE_INIT = 0; + + private static final int STATE_LOOP = 1; + + private static final int STATE_DONE = 2; - JPanel iconimg = new JPanel(new BorderLayout()); + // boolean visible = true; + + private JPanel iconimg = new JPanel(new BorderLayout()); /** - * either text area in javascript or in java text pane + * Temporary SwingJS Hack: Either a JLabel in JavaScript or a JTextPane in + * Java */ - Component authlist; + protected Component htmlPane; + + 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; @@ -75,7 +98,7 @@ public class SplashScreen extends JPanel this(false); } - private boolean interactiveDialog = false; + protected boolean isInteractive = false; /** * @@ -83,29 +106,11 @@ public class SplashScreen extends JPanel * 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 - if (Platform.isJS()) // BH 2019 - { - authlist = new JLabel(""); - run(); - } - else - { - /** - * Java only - * - * @j2sIgnore - */ - { - authlist = new JTextPane(); - Thread t = new Thread(this, "SplashScreen"); - t.start(); - } - } - + this.isInteractive = isInteractive; + Thread t = new Thread(this, "SplashScreen"); + t.start(); } MouseAdapter closer = new MouseAdapter() @@ -115,9 +120,9 @@ public class SplashScreen extends JPanel { try { - if (!interactiveDialog) + if (!isInteractive) { - visible = false; + setVisible(false); closeSplash(); } } catch (Exception ex) @@ -130,93 +135,87 @@ public class SplashScreen extends JPanel * 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 (!Platform.isJS() && 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 + } + do + { + try { - try - { - mt.waitForAll(); - } catch (InterruptedException x) - { - } - if (mt.isErrorAny()) - { - System.err.println("Error when loading images!"); - } - } while (!mt.checkAll()); + 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); - if (Platform.isJS()) - { - // ignore in JavaScript - } - else - /** - * Java only - * - * @j2sIgnore - */ - { - ((JTextPane) authlist).setEditable(false); - - SplashImage splashimg = new SplashImage(image); - iconimg.add(splashimg, BorderLayout.CENTER); - add(iconimg, BorderLayout.NORTH); - } - add(authlist, BorderLayout.CENTER); - authlist.addMouseListener(closer); + SplashImage splashimg = new SplashImage(image); + iconimg.add(splashimg, BorderLayout.CENTER); + add(iconimg, BorderLayout.NORTH); Desktop.getDesktopPane().add(iframe); refreshText(); } - long oldtext = -1; + String oldtext; + + private int mainState; /** * update text in author text panel reflecting current version information */ - @SuppressWarnings("unused") protected boolean refreshText() { Desktop desktop = Desktop.getInstance(); String newtext = desktop.getAboutMessage(true).toString(); // System.err.println("Text found: \n"+newtext+"\nEnd of newtext."); - if (oldtext != newtext.length()) + if (!newtext.equals(oldtext)) { iframe.setVisible(false); - oldtext = newtext.length(); + oldtext = newtext; if (Platform.isJS()) // BH 2019 { - authlist = new JLabel( - "


" - + newtext); - ((JLabel) authlist).setOpaque(true); - ((JLabel) authlist).setBackground(Color.white); + // 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 /** @@ -225,22 +224,23 @@ public class SplashScreen extends JPanel * @j2sIgnore */ { - authlist = new JTextPane(); - ((JTextPane) authlist).setEditable(false); - ((JTextPane) authlist).setContentType("text/html"); - ((JTextPane) authlist).setText(newtext); - ((JTextPane) authlist).addHyperlinkListener(this); + 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; } - authlist.addMouseListener(closer); - - authlist.setVisible(true); - authlist.setSize(new Dimension(750, 375)); - add(authlist, BorderLayout.CENTER); - revalidate(); - iframe.setBounds((desktop.getWidth() - 750) / 2, - (desktop.getHeight() - 375) / 2, 750, - authlist.getHeight() + iconimg.getHeight()); - iframe.validate(); + 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; } @@ -253,61 +253,89 @@ public class SplashScreen extends JPanel @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) - { - } - - if (!interactiveDialog - && ((System.currentTimeMillis() / 1000) - startTime) > 5) + switch (mainState) { - 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) + { + System.out.println(htmlPane.getFont()); + 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.getInstance().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) { @@ -331,7 +359,7 @@ public class SplashScreen 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)); + g.setFont(largeFont); if (image != null) { @@ -387,4 +415,5 @@ public class SplashScreen extends JPanel Desktop.hyperlinkUpdate(e); } + } -- 1.7.10.2