*/
package jalview.gui;
-import jalview.util.Platform;
import java.awt.BorderLayout;
import java.awt.Color;
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 java.net.URL;
import javax.swing.JInternalFrame;
import javax.swing.JLabel;
import javax.swing.event.HyperlinkEvent;
import javax.swing.event.HyperlinkListener;
+import jalview.util.ChannelProperties;
+import jalview.util.Platform;
/**
* DOCUMENT ME!
*
* @author $author$
* @version $Revision$
*/
+@SuppressWarnings("serial")
public class SplashScreen extends JPanel
- implements Runnable, HyperlinkListener
+ implements HyperlinkListener, StateMachine
{
+
+ private static final int STATE_INIT = 0;
+
+ private static final int STATE_LOOP = 1;
+
+ private static final int STATE_DONE = 2;
+
private static final int SHOW_FOR_SECS = 5;
- private static final int FONT_SIZE = 11;
+ private static final int FONT_SIZE = (Platform.isJS() ? 14 : 11);
private boolean visible = true;
private JPanel iconimg = new JPanel(new BorderLayout());
+ // 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
*/
{
try
{
- visible = false;
closeSplash();
} catch (Exception ex)
{
/**
* Constructor that displays the splash screen
*
- * @param isTransient
+ * @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
+ * if false it stays up until closed by the user (from Help..About menu)
*/
- public SplashScreen(boolean isTransient)
+ public SplashScreen(boolean isStartup)
{
- this.transientDialog = isTransient;
-
- if (Platform.isJS()) // BH 2019
- {
- splashText = new JLabel("");
- run();
- }
- else
- {
- /**
- * Java only
- *
- * @j2sIgnore
- */
- {
- splashText = new JTextPane();
- Thread t = new Thread(this);
- t.start();
- }
- }
+ 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);
}
- /**
- * ping the jalview version page then create and display the jalview
- * splashscreen window.
- */
- void initSplashScreenWindow()
+ protected void initSplashScreenWindow()
{
addMouseListener(closer);
-
- try
- {
- URL url = getClass().getResource("/images/Jalview_Logo.png");
- URL urllogo = getClass()
- .getResource("/images/Jalview_Logo_small.png");
-
- if (!Platform.isJS() && url != null)
- {
- image = Toolkit.getDefaultToolkit().createImage(url);
- Image logo = 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.getInstance().setIconImage(logo);
- }
- } catch (Exception ex)
- {
- }
-
+ waitForImages();
+ setLayout(new BorderLayout());
iframe = new JInternalFrame();
iframe.setFrameIcon(null);
iframe.setClosable(true);
- this.setLayout(new BorderLayout());
iframe.setContentPane(this);
- iframe.setLayer(JLayeredPane.PALETTE_LAYER);
- if (Platform.isJS())
- {
- // ignore in JavaScript
- }
- else
- /**
- * Java only
- *
- * @j2sIgnore
- */
- {
- ((JTextPane) splashText).setEditable(false);
-
- SplashImage splashimg = new SplashImage(image);
- iconimg.add(splashimg, BorderLayout.CENTER);
- add(iconimg, BorderLayout.NORTH);
- }
- add(splashText, BorderLayout.CENTER);
- splashText.addMouseListener(closer);
+ iframe.setLayer(JLayeredPane.PALETTE_LAYER);
+ SplashImage splashimg = new SplashImage(image);
+ imgPanel.add(splashimg, BorderLayout.CENTER);
+ add(imgPanel, BorderLayout.NORTH);
Desktop.getDesktopPane().add(iframe);
refreshText();
}
/**
- * 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.getInstance().getAboutMessage();
- // System.err.println("Text found: \n"+newtext+"\nEnd of newtext.");
- if (oldTextLength != newtext.length())
+ if (Platform.isJS())
+ return;
+ MediaTracker mt = new MediaTracker(this);
+ mt.addImage(image, 0);
+ mt.addImage(logo, 1);
+ do
{
- iframe.setVisible(false);
- oldTextLength = newtext.length();
- if (Platform.isJS()) // BH 2019
+ try
+ {
+ mt.waitForAll();
+ } catch (InterruptedException x)
{
- /*
- * SwingJS doesn't have HTMLEditorKit, required for a JTextPane
- * to display formatted html, so we use a simple alternative
- */
- String text = "<html><br><br><img src=\"swingjs/j2s/images/Jalview_Logo.png\"/><br>"
- + newtext + "</html>";
- JLabel ta = new JLabel(text);
- ta.setOpaque(true);
- ta.setBackground(Color.white);
- splashText = ta;
}
- else
- /**
- * Java only
- *
- * @j2sIgnore
- */
+ if (mt.isErrorAny())
{
- JTextPane jtp = new JTextPane();
- jtp.setEditable(false);
- jtp.setContentType("text/html");
- jtp.setText("<html>" + newtext + "</html>");
- jtp.addHyperlinkListener(this);
- splashText = jtp;
+ System.err.println("Error when loading images!");
+ break;
}
- splashText.addMouseListener(closer);
-
- splashText.setVisible(true);
- splashText.setSize(new Dimension(750, 375));
- add(splashText, BorderLayout.CENTER);
- revalidate();
- iframe.setBounds((Desktop.getInstance().getWidth() - 750) / 2,
- (Desktop.getInstance().getHeight() - 375) / 2, 750,
- splashText.getHeight() + iconimg.getHeight());
- iframe.validate();
- iframe.setVisible(true);
- return true;
+ } while (!mt.checkAll());
+ if (logo != null)
+ {
+ Desktop.getInstance().setIconImage(logo);
}
- return false;
+ this.setBackground(bg);
+ this.setForeground(fg);
+ this.setFont(font);
}
/**
- * Create splash screen, display it and clear it off again.
+ * update text in author text panel reflecting current version information
*/
- @Override
- public void run()
+ protected boolean refreshText()
{
- initSplashScreenWindow();
-
- long startTime = System.currentTimeMillis() / 1000;
-
- while (visible)
+ String newtext = Desktop.getInstance().getAboutMessage();
+ // System.err.println("Text found: \n"+newtext+"\nEnd of newtext.");
+ if (oldTextLength == newtext.length())
{
- iframe.repaint();
- try
- {
- Thread.sleep(500);
- } catch (Exception ex)
- {
- }
-
- if (transientDialog
- && ((System.currentTimeMillis() / 1000) - startTime) > SHOW_FOR_SECS)
- {
- visible = false;
- }
-
- if (visible && refreshText())
- {
- iframe.repaint();
- }
- if (!transientDialog)
- {
- return;
- }
+ 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);
- closeSplash();
- Desktop.getInstance().startDialogQueue();
+ 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;
}
- /**
- * DOCUMENT ME!
- */
- public void closeSplash()
+ 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;
@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, FONT_SIZE + 6));
+ g.setColor(fg);
+ g.setFont(new Font(font.getFontName(), Font.BOLD, FONT_SIZE + 6));
if (image != null)
{