From 5757f3c3ee60e52a2446ab111f35452cf4435ab2 Mon Sep 17 00:00:00 2001 From: gmungoc Date: Tue, 12 Nov 2019 08:46:14 +0000 Subject: [PATCH] JAL-3274 resource path correction, code tidying (constants etc) --- src/jalview/bin/Cache.java | 25 ++--- src/jalview/bin/Jalview.java | 13 +-- src/jalview/gui/Desktop.java | 104 ++++++++----------- src/jalview/gui/SplashScreen.java | 205 +++++++++++++++---------------------- src/jalview/util/Platform.java | 11 +- 5 files changed, 146 insertions(+), 212 deletions(-) diff --git a/src/jalview/bin/Cache.java b/src/jalview/bin/Cache.java index 9e28f5d..94a1825 100755 --- a/src/jalview/bin/Cache.java +++ b/src/jalview/bin/Cache.java @@ -38,6 +38,7 @@ import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.InputStream; import java.io.InputStreamReader; +import java.net.URL; import java.text.DateFormat; import java.text.SimpleDateFormat; import java.util.Collections; @@ -396,13 +397,13 @@ public class Cache } // LOAD THE AUTHORS FROM THE authors.props file - String authorDetails = resolveResourceURLFor("authors.props"); + String authorDetails = resolveResourceURLFor("/authors.props"); try { if (authorDetails != null) { - java.net.URL localJarFileURL = new java.net.URL(authorDetails); + URL localJarFileURL = new URL(authorDetails); InputStream in = localJarFileURL.openStream(); applicationProperties.load(in); in.close(); @@ -542,7 +543,8 @@ public class Cache url = Cache.class.getResource(resourcePath).toString(); } catch (Exception ex) { - + System.err.println("Failed to resolve resource " + resourcePath + ": " + + ex.getMessage()); } } else @@ -556,17 +558,16 @@ public class Cache public static void loadBuildProperties(boolean reportVersion) { String codeInstallation = getProperty("INSTALLATION"); - boolean printV = codeInstallation == null; + boolean printVersion = codeInstallation == null; - // FIND THE VERSION NUMBER AND BUILD DATE FROM jalview.jar + /* + * read build properties - from the Jalview jar for a Java distribution, + * or from codebase file in test or JalviewJS context + */ try { - String buildDetails = "jar:".concat(Cache.class.getProtectionDomain() - .getCodeSource().getLocation().toString() - .concat("!/.build_properties")); - - java.net.URL localJarFileURL = new java.net.URL(buildDetails); - + String buildDetails = resolveResourceURLFor("/.build_properties"); + URL localJarFileURL = new URL(buildDetails); InputStream in = localJarFileURL.openStream(); applicationProperties.load(in); in.close(); @@ -590,7 +591,7 @@ public class Cache } setProperty("VERSION", codeVersion); new BuildDetails(codeVersion, null, codeInstallation); - if (printV && reportVersion) + if (printVersion && reportVersion) { System.out .println("Jalview Version: " + codeVersion + codeInstallation); diff --git a/src/jalview/bin/Jalview.java b/src/jalview/bin/Jalview.java index 71902c0..9ba7a7f 100755 --- a/src/jalview/bin/Jalview.java +++ b/src/jalview/bin/Jalview.java @@ -415,15 +415,12 @@ public class Jalview desktop = new Desktop(); desktop.setInBatchMode(true); // indicate we are starting up - if (!Platform.isJS()) + try { - try - { - JalviewTaskbar.setTaskbar(this); - } catch (Throwable t) - { - System.out.println("Error setting Taskbar: " + t.getMessage()); - } + JalviewTaskbar.setTaskbar(this); + } catch (Throwable t) + { + System.out.println("Error setting Taskbar: " + t.getMessage()); } desktop.setVisible(true); diff --git a/src/jalview/gui/Desktop.java b/src/jalview/gui/Desktop.java index 6bb9b36..7682ee6 100644 --- a/src/jalview/gui/Desktop.java +++ b/src/jalview/gui/Desktop.java @@ -134,6 +134,15 @@ public class Desktop extends jalview.jbgui.GDesktop implements DropTargetListener, ClipboardOwner, IProgressIndicator, jalview.api.StructureSelectionManagerProvider { + private static final String CITATION = "

Development managed by The Barton Group, University of Dundee, Scotland, UK.
" + + "

For help, see the FAQ at www.jalview.org/faq and/or join the jalview-discuss@jalview.org mailing list" + + "

If you use Jalview, please cite:" + + "
Waterhouse, A.M., Procter, J.B., Martin, D.M.A, Clamp, M. and Barton, G. J. (2009)" + + "
Jalview Version 2 - a multiple sequence alignment editor and analysis workbench" + + "
Bioinformatics doi: 10.1093/bioinformatics/btp033"; + + private static final String DEFAULT_AUTHORS = "The Jalview Authors (See AUTHORS file for current list)"; + private static int DEFAULT_MIN_WIDTH = 300; private static int DEFAULT_MIN_HEIGHT = 250; @@ -440,20 +449,8 @@ public class Desktop extends jalview.jbgui.GDesktop * @j2sIgnore */ { - jconsole = new Console(this, showjconsole); - // add essential build information - jconsole.setHeader("Jalview Version: " - + Cache.getProperty("VERSION") + "\n" - + "Jalview Installation: " - + Cache.getDefault("INSTALLATION", "unknown") - + "\n" + "Build Date: " - + Cache.getDefault("BUILD_DATE", "unknown") + "\n" - + "Java version: " + System.getProperty("java.version") + "\n" - + System.getProperty("os.arch") + " " - + System.getProperty("os.name") + " " - + System.getProperty("os.version")); - + jconsole.setHeader(Cache.getVersionDetailsForConsole()); showConsole(showjconsole); showNews.setVisible(false); @@ -471,7 +468,7 @@ public class Desktop extends jalview.jbgui.GDesktop @Override public void run() { - new SplashScreen(); + new SplashScreen(true); } }); @@ -1346,52 +1343,40 @@ public class Desktop extends jalview.jbgui.GDesktop @Override public void aboutMenuItem_actionPerformed(ActionEvent e) { - // StringBuffer message = getAboutMessage(false); - // JvOptionPane.showInternalMessageDialog(Desktop.desktop, - // - // message.toString(), "About Jalview", JvOptionPane.INFORMATION_MESSAGE); new Thread(new Runnable() { @Override public void run() { - new SplashScreen(true); + new SplashScreen(false); } }).start(); } - public StringBuffer getAboutMessage(boolean shortv) + /** + * Returns the html text for the About screen, including any available version + * number, build details, author details and citation reference, but without + * the enclosing {@code html} tags + * + * @return + */ + public String getAboutMessage() { - StringBuffer message = new StringBuffer(); - message.append(""); - if (shortv) - { - message.append("

Version: " - + Cache.getProperty("VERSION") - + "

"); - message.append("Built: " - + Cache.getDefault("BUILD_DATE", "unknown") + " from " - + Cache.getBuildDetailsForSplash() - + ""); - - } - else - { - - message.append("Version " - + Cache.getProperty("VERSION") - + "; last updated: " - + Cache.getDefault("BUILD_DATE", "unknown")); - } + StringBuilder message = new StringBuilder(1024); + message.append("

Version: ") + .append(Cache.getProperty("VERSION")).append("

") + .append("Built: ") + .append(Cache.getDefault("BUILD_DATE", "unknown")) + .append(" from ").append(Cache.getBuildDetailsForSplash()) + .append(""); - if (Cache.getDefault("LATEST_VERSION", "Checking") - .equals("Checking")) + String latestVersion = Cache.getDefault("LATEST_VERSION", "Checking"); + if (latestVersion.equals("Checking")) { // JBP removed this message for 2.11: May be reinstated in future version // message.append("
...Checking latest version...
"); } - else if (!Cache.getDefault("LATEST_VERSION", "Checking") - .equals(Cache.getProperty("VERSION"))) + else if (!latestVersion.equals(Cache.getProperty("VERSION"))) { boolean red = false; if (Cache.getProperty("VERSION").toLowerCase() @@ -1403,29 +1388,22 @@ public class Desktop extends jalview.jbgui.GDesktop message.append("
"); } - message.append("
!! Version " - + Cache.getDefault("LATEST_VERSION", - "..Checking..") - + " is available for download from " - + Cache.getDefault("www.jalview.org", - "http://www.jalview.org") - + " !!"); + message.append("
!! Version ") + .append(Cache.getDefault("LATEST_VERSION", "..Checking..")) + .append(" is available for download from ") + .append(Cache.getDefault("www.jalview.org", + "http://www.jalview.org")) + .append(" !!"); if (red) { message.append("
"); } } - message.append("
Authors: " + Cache.getDefault( - "AUTHORFNAMES", - "The Jalview Authors (See AUTHORS file for current list)") - + "

Development managed by The Barton Group, University of Dundee, Scotland, UK.
" - + "

For help, see the FAQ at www.jalview.org/faq and/or join the jalview-discuss@jalview.org mailing list" - + "

If you use Jalview, please cite:" - + "
Waterhouse, A.M., Procter, J.B., Martin, D.M.A, Clamp, M. and Barton, G. J. (2009)" - + "
Jalview Version 2 - a multiple sequence alignment editor and analysis workbench" - + "
Bioinformatics doi: 10.1093/bioinformatics/btp033" - + ""); - return message; + message.append("
Authors: "); + message.append(Cache.getDefault("AUTHORFNAMES", DEFAULT_AUTHORS)); + message.append(CITATION); + + return message.toString(); } /** diff --git a/src/jalview/gui/SplashScreen.java b/src/jalview/gui/SplashScreen.java index 2b87e10..f4b275d 100755 --- a/src/jalview/gui/SplashScreen.java +++ b/src/jalview/gui/SplashScreen.java @@ -30,8 +30,10 @@ 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 java.net.URL; import javax.swing.JInternalFrame; import javax.swing.JLabel; @@ -50,82 +52,80 @@ import javax.swing.event.HyperlinkListener; public class SplashScreen extends JPanel implements Runnable, HyperlinkListener { - boolean visible = true; + private static final int SHOW_FOR_SECS = 5; - JPanel iconimg = new JPanel(new BorderLayout()); + private static final int FONT_SIZE = 11; - /** - * either text area in javascript or in java text pane + private boolean visible = true; + + private JPanel iconimg = new JPanel(new BorderLayout()); + + /* + * as JTextPane in Java, JLabel in javascript */ - Component authlist; + private Component splashText; - JInternalFrame iframe; + private JInternalFrame iframe; - Image image; + private Image image; - int fontSize = 11; + private boolean transientDialog = false; - int yoffset = 30; + private long oldTextLength = -1; - /** - * Creates a new SplashScreen object. + /* + * allow click in the initial splash screen to dismiss it + * immediately (not if opened from About menu) */ - public SplashScreen() + private MouseAdapter closer = new MouseAdapter() { - this(false); - } - - private boolean interactiveDialog = false; + @Override + public void mousePressed(MouseEvent evt) + { + if (transientDialog) + { + try + { + visible = false; + closeSplash(); + } catch (Exception ex) + { + } + } + } + }; /** + * Constructor that displays the splash screen * - * @param interactive - * if true - an internal dialog is opened rather than a free-floating - * splash screen + * @param isTransient + * if true the panel removes itself on click or after a few seconds; + * if false it stays up until closed by the user */ - public SplashScreen(boolean interactive) + public SplashScreen(boolean isTransient) { - this.interactiveDialog = interactive; - // show a splashscreen that will disapper + this.transientDialog = isTransient; + if (Platform.isJS()) // BH 2019 { - authlist = new JLabel(""); + splashText = new JLabel(""); run(); } else { /** * Java only - * + * * @j2sIgnore */ { - authlist = new JTextPane(); + splashText = new JTextPane(); Thread t = new Thread(this); t.start(); } } - } - MouseAdapter closer = new MouseAdapter() - { - @Override - public void mousePressed(MouseEvent evt) - { - try - { - if (!interactiveDialog) - { - visible = false; - closeSplash(); - } - } catch (Exception ex) - { - } - } - }; - /** * ping the jalview version page then create and display the jalview * splashscreen window. @@ -133,17 +133,17 @@ public class SplashScreen extends JPanel void initSplashScreenWindow() { addMouseListener(closer); + try { - java.net.URL url = getClass().getResource("/images/Jalview_Logo.png"); - java.net.URL urllogo = getClass() + URL url = getClass().getResource("/images/Jalview_Logo.png"); + URL urllogo = getClass() .getResource("/images/Jalview_Logo_small.png"); if (!Platform.isJS() && url != null) { - image = java.awt.Toolkit.getDefaultToolkit().createImage(url); - Image logo = java.awt.Toolkit.getDefaultToolkit() - .createImage(urllogo); + image = Toolkit.getDefaultToolkit().createImage(url); + Image logo = Toolkit.getDefaultToolkit().createImage(urllogo); MediaTracker mt = new MediaTracker(this); mt.addImage(image, 0); mt.addImage(logo, 1); @@ -168,7 +168,7 @@ public class SplashScreen extends JPanel iframe = new JInternalFrame(); iframe.setFrameIcon(null); - iframe.setClosable(interactiveDialog); + iframe.setClosable(true); this.setLayout(new BorderLayout()); iframe.setContentPane(this); iframe.setLayer(JLayeredPane.PALETTE_LAYER); @@ -183,62 +183,65 @@ public class SplashScreen extends JPanel * @j2sIgnore */ { - ((JTextPane) authlist).setEditable(false); + ((JTextPane) splashText).setEditable(false); SplashImage splashimg = new SplashImage(image); iconimg.add(splashimg, BorderLayout.CENTER); add(iconimg, BorderLayout.NORTH); } - add(authlist, BorderLayout.CENTER); - authlist.addMouseListener(closer); + add(splashText, BorderLayout.CENTER); + splashText.addMouseListener(closer); Desktop.desktop.add(iframe); refreshText(); } - long oldtext = -1; - /** * update text in author text panel reflecting current version information */ - @SuppressWarnings("unused") protected boolean refreshText() { - String newtext = Desktop.instance.getAboutMessage(true).toString(); + String newtext = Desktop.instance.getAboutMessage(); // System.err.println("Text found: \n"+newtext+"\nEnd of newtext."); - if (oldtext != newtext.length()) + if (oldTextLength != newtext.length()) { iframe.setVisible(false); - oldtext = newtext.length(); + oldTextLength = newtext.length(); if (Platform.isJS()) // BH 2019 { - authlist = new JLabel( - "


" - + newtext); - ((JLabel) authlist).setOpaque(true); - ((JLabel) authlist).setBackground(Color.white); + /* + * SwingJS doesn't have HTMLEditorKit, required for a JTextPane + * to display formatted html, so we use a simple alternative + */ + String text = "


" + + newtext + ""; + JLabel ta = new JLabel(text); + ta.setOpaque(true); + ta.setBackground(Color.white); + splashText = ta; } else /** * Java only - * + * * @j2sIgnore */ { - authlist = new JTextPane(); - ((JTextPane) authlist).setEditable(false); - ((JTextPane) authlist).setContentType("text/html"); - ((JTextPane) authlist).setText(newtext); - ((JTextPane) authlist).addHyperlinkListener(this); + JTextPane jtp = new JTextPane(); + jtp.setEditable(false); + jtp.setContentType("text/html"); + jtp.setText("" + newtext + ""); + jtp.addHyperlinkListener(this); + splashText = jtp; } - authlist.addMouseListener(closer); + splashText.addMouseListener(closer); - authlist.setVisible(true); - authlist.setSize(new Dimension(750, 375)); - add(authlist, BorderLayout.CENTER); + splashText.setVisible(true); + splashText.setSize(new Dimension(750, 375)); + add(splashText, BorderLayout.CENTER); revalidate(); iframe.setBounds((Desktop.instance.getWidth() - 750) / 2, (Desktop.instance.getHeight() - 375) / 2, 750, - authlist.getHeight() + iconimg.getHeight()); + splashText.getHeight() + iconimg.getHeight()); iframe.validate(); iframe.setVisible(true); return true; @@ -266,21 +269,17 @@ public class SplashScreen extends JPanel { } - if (!interactiveDialog - && ((System.currentTimeMillis() / 1000) - startTime) > 5) + if (transientDialog + && ((System.currentTimeMillis() / 1000) - startTime) > SHOW_FOR_SECS) { visible = false; } if (visible && refreshText()) { - // if (interactiveDialog) { iframe.repaint(); - // } else { - // iframe.repaint(); - // }; } - if (interactiveDialog) + if (!transientDialog) { return; } @@ -330,7 +329,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(new Font("Verdana", Font.BOLD, FONT_SIZE + 6)); if (image != null) { @@ -338,46 +337,6 @@ public class SplashScreen extends JPanel (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 diff --git a/src/jalview/util/Platform.java b/src/jalview/util/Platform.java index 44d93b7..e9afb70 100644 --- a/src/jalview/util/Platform.java +++ b/src/jalview/util/Platform.java @@ -337,9 +337,7 @@ public class Platform public static byte[] getFileBytes(File f) { - // TODO temporary doubling of 秘bytes and _bytes; - // just remove _bytes when new transpiler has been installed - return /** @j2sNative f && (f.\u79d8bytes || f._bytes) || */ + return /** @j2sNative f && swingjs.JSUtil.getFileBytes$O(f) || */ null; } @@ -435,7 +433,7 @@ public class Platform @SuppressWarnings("unused") ThreadGroup g = Thread.currentThread().getThreadGroup(); /** - * @j2sNative return g.\u79d8html5Applet._uniqueId; + * @j2sNative return g.getHtmlApplet$()._uniqueId; * */ return null; @@ -461,8 +459,9 @@ public class Platform String id = getUniqueAppletID(); String key = "", value = ""; /** - * @j2sNative var info = g.\u79d8html5Applet.__Info || {}; for (var key in info) { - * if (key.indexOf(prefix) == 0) { value = "" + info[key]; + * @j2sNative var info = g.getHtmlApplet$().__Info || {}; for (var key in + * info) { if (key.indexOf(prefix) == 0) { value = "" + + * info[key]; */ System.out.println( -- 1.7.10.2