src/jalview/gui/Desktop.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import java.awt.BorderLayout;
  24 import java.awt.Color;
  25 import java.awt.Dimension;
  26 import java.awt.FontMetrics;
  27 import java.awt.Graphics;
  28 import java.awt.Graphics2D;
  29 import java.awt.GridLayout;
  30 import java.awt.Point;
  31 import java.awt.Rectangle;
  32 import java.awt.Toolkit;
  33 import java.awt.Window;
  34 import java.awt.datatransfer.Clipboard;
  35 import java.awt.datatransfer.ClipboardOwner;
  36 import java.awt.datatransfer.DataFlavor;
  37 import java.awt.datatransfer.Transferable;
  38 import java.awt.dnd.DnDConstants;
  39 import java.awt.dnd.DropTargetDragEvent;
  40 import java.awt.dnd.DropTargetDropEvent;
  41 import java.awt.dnd.DropTargetEvent;
  42 import java.awt.dnd.DropTargetListener;
  43 import java.awt.event.ActionEvent;
  44 import java.awt.event.ActionListener;
  45 import java.awt.event.InputEvent;
  46 import java.awt.event.KeyEvent;
  47 import java.awt.event.MouseAdapter;
  48 import java.awt.event.MouseEvent;
  49 import java.awt.event.WindowAdapter;
  50 import java.awt.event.WindowEvent;
  51 import java.awt.geom.AffineTransform;
  52 import java.beans.PropertyChangeEvent;
  53 import java.beans.PropertyChangeListener;
  54 import java.io.File;
  55 import java.io.FileWriter;
  56 import java.io.IOException;
  57 import java.lang.reflect.Field;
  58 import java.net.URL;
  59 import java.util.ArrayList;
  60 import java.util.Arrays;
  61 import java.util.HashMap;
  62 import java.util.Hashtable;
  63 import java.util.List;
  64 import java.util.ListIterator;
  65 import java.util.Locale;
  66 import java.util.Vector;
  67 import java.util.concurrent.ExecutorService;
  68 import java.util.concurrent.Executors;
  69 import java.util.concurrent.Semaphore;
  70
  71 import javax.swing.AbstractAction;
  72 import javax.swing.Action;
  73 import javax.swing.ActionMap;
  74 import javax.swing.Box;
  75 import javax.swing.BoxLayout;
  76 import javax.swing.DefaultDesktopManager;
  77 import javax.swing.DesktopManager;
  78 import javax.swing.InputMap;
  79 import javax.swing.JButton;
  80 import javax.swing.JCheckBox;
  81 import javax.swing.JComboBox;
  82 import javax.swing.JComponent;
  83 import javax.swing.JDesktopPane;
  84 import javax.swing.JInternalFrame;
  85 import javax.swing.JLabel;
  86 import javax.swing.JMenuItem;
  87 import javax.swing.JPanel;
  88 import javax.swing.JPopupMenu;
  89 import javax.swing.JProgressBar;
  90 import javax.swing.JTextField;
  91 import javax.swing.KeyStroke;
  92 import javax.swing.SwingUtilities;
  93 import javax.swing.event.HyperlinkEvent;
  94 import javax.swing.event.HyperlinkEvent.EventType;
  95 import javax.swing.event.InternalFrameAdapter;
  96 import javax.swing.event.InternalFrameEvent;
  97
  98 import org.stackoverflowusers.file.WindowsShortcut;
  99
 100 import jalview.api.AlignViewportI;
 101 import jalview.api.AlignmentViewPanel;
 102 import jalview.bin.Cache;
 103 import jalview.bin.Jalview;
 104 import jalview.gui.ImageExporter.ImageWriterI;
 105 import jalview.io.BackupFiles;
 106 import jalview.io.DataSourceType;
 107 import jalview.io.FileFormat;
 108 import jalview.io.FileFormatException;
 109 import jalview.io.FileFormatI;
 110 import jalview.io.FileFormats;
 111 import jalview.io.FileLoader;
 112 import jalview.io.FormatAdapter;
 113 import jalview.io.IdentifyFile;
 114 import jalview.io.JalviewFileChooser;
 115 import jalview.io.JalviewFileView;
 116 import jalview.jbgui.GSplitFrame;
 117 import jalview.jbgui.GStructureViewer;
 118 import jalview.project.Jalview2XML;
 119 import jalview.structure.StructureSelectionManager;
 120 import jalview.urls.IdOrgSettings;
 121 import jalview.util.BrowserLauncher;
 122 import jalview.util.ChannelProperties;
 123 import jalview.util.ImageMaker.TYPE;
 124 import jalview.util.MessageManager;
 125 import jalview.util.Platform;
 126 import jalview.util.ShortcutKeyMaskExWrapper;
 127 import jalview.util.UrlConstants;
 128 import jalview.viewmodel.AlignmentViewport;
 129 import jalview.ws.params.ParamManager;
 130 import jalview.ws.utils.UrlDownloadClient;
 131
 132 /**
 133  * Jalview Desktop
 134  *
 135  *
 136  * @author $author$
 137  * @version $Revision: 1.155 $
 138  */
 139 public class Desktop extends jalview.jbgui.GDesktop
 140         implements DropTargetListener, ClipboardOwner, IProgressIndicator,
 141         jalview.api.StructureSelectionManagerProvider
 142 {
 143   private static final String CITATION;
 144   static
 145   {
 146     URL bg_logo_url = ChannelProperties.getImageURL(
 147             "bg_logo." + String.valueOf(SplashScreen.logoSize));
 148     URL uod_logo_url = ChannelProperties.getImageURL(
 149             "uod_banner." + String.valueOf(SplashScreen.logoSize));
 150     boolean logo = (bg_logo_url != null || uod_logo_url != null);
 151     StringBuilder sb = new StringBuilder();
 152     sb.append(
 153             "<br><br>Jalview is free software released under GPLv3.<br><br>Development is managed by The Barton Group, University of Dundee, Scotland, UK.");
 154     if (logo)
 155     {
 156       sb.append("<br>");
 157     }
 158     sb.append(bg_logo_url == null ? ""
 159             : "<img alt=\"Barton Group logo\" src=\""
 160                     + bg_logo_url.toString() + "\">");
 161     sb.append(uod_logo_url == null ? ""
 162             : "&nbsp;<img alt=\"University of Dundee shield\" src=\""
 163                     + uod_logo_url.toString() + "\">");
 164     sb.append(
 165             "<br><br>For help, see <a href=\"https://www.jalview.org/faq\">www.jalview.org/faq</a> and join <a href=\"https://discourse.jalview.org\">discourse.jalview.org</a>");
 166     sb.append("<br><br>If  you use Jalview, please cite:"
 167             + "<br>Waterhouse, A.M., Procter, J.B., Martin, D.M.A, Clamp, M. and Barton, G. J. (2009)"
 168             + "<br>Jalview Version 2 - a multiple sequence alignment editor and analysis workbench"
 169             + "<br>Bioinformatics <a href=\"https://doi.org/10.1093/bioinformatics/btp033\">doi: 10.1093/bioinformatics/btp033</a>");
 170     CITATION = sb.toString();
 171   }
 172
 173   private static final String DEFAULT_AUTHORS = "The Jalview Authors (See AUTHORS file for current list)";
 174
 175   private static int DEFAULT_MIN_WIDTH = 300;
 176
 177   private static int DEFAULT_MIN_HEIGHT = 250;
 178
 179   private static int ALIGN_FRAME_DEFAULT_MIN_WIDTH = 600;
 180
 181   private static int ALIGN_FRAME_DEFAULT_MIN_HEIGHT = 70;
 182
 183   private static final String EXPERIMENTAL_FEATURES = "EXPERIMENTAL_FEATURES";
 184
 185   protected static final String CONFIRM_KEYBOARD_QUIT = "CONFIRM_KEYBOARD_QUIT";
 186
 187   public static HashMap<String, FileWriter> savingFiles = new HashMap<String, FileWriter>();
 188
 189   private JalviewChangeSupport changeSupport = new JalviewChangeSupport();
 190
 191   public static boolean nosplash = false;
 192
 193   /**
 194    * news reader - null if it was never started.
 195    */
 196   private BlogReader jvnews = null;
 197
 198   private File projectFile;
 199
 200   /**
 201    * @param listener
 202    * @see jalview.gui.JalviewChangeSupport#addJalviewPropertyChangeListener(java.beans.PropertyChangeListener)
 203    */
 204   public void addJalviewPropertyChangeListener(
 205           PropertyChangeListener listener)
 206   {
 207     changeSupport.addJalviewPropertyChangeListener(listener);
 208   }
 209
 210   /**
 211    * @param propertyName
 212    * @param listener
 213    * @see jalview.gui.JalviewChangeSupport#addJalviewPropertyChangeListener(java.lang.String,
 214    *      java.beans.PropertyChangeListener)
 215    */
 216   public void addJalviewPropertyChangeListener(String propertyName,
 217           PropertyChangeListener listener)
 218   {
 219     changeSupport.addJalviewPropertyChangeListener(propertyName, listener);
 220   }
 221
 222   /**
 223    * @param propertyName
 224    * @param listener
 225    * @see jalview.gui.JalviewChangeSupport#removeJalviewPropertyChangeListener(java.lang.String,
 226    *      java.beans.PropertyChangeListener)
 227    */
 228   public void removeJalviewPropertyChangeListener(String propertyName,
 229           PropertyChangeListener listener)
 230   {
 231     changeSupport.removeJalviewPropertyChangeListener(propertyName,
 232             listener);
 233   }
 234
 235   /** Singleton Desktop instance */
 236   public static Desktop instance;
 237
 238   public static MyDesktopPane desktop;
 239
 240   public static MyDesktopPane getDesktop()
 241   {
 242     // BH 2018 could use currentThread() here as a reference to a
 243     // Hashtable<Thread, MyDesktopPane> in JavaScript
 244     return desktop;
 245   }
 246
 247   static int openFrameCount = 0;
 248
 249   static final int xOffset = 30;
 250
 251   static final int yOffset = 30;
 252
 253   public static jalview.ws.jws1.Discoverer discoverer;
 254
 255   public static Object[] jalviewClipboard;
 256
 257   public static boolean internalCopy = false;
 258
 259   static int fileLoadingCount = 0;
 260
 261   class MyDesktopManager implements DesktopManager
 262   {
 263
 264     private DesktopManager delegate;
 265
 266     public MyDesktopManager(DesktopManager delegate)
 267     {
 268       this.delegate = delegate;
 269     }
 270
 271     @Override
 272     public void activateFrame(JInternalFrame f)
 273     {
 274       try
 275       {
 276         delegate.activateFrame(f);
 277       } catch (NullPointerException npe)
 278       {
 279         Point p = getMousePosition();
 280         instance.showPasteMenu(p.x, p.y);
 281       }
 282     }
 283
 284     @Override
 285     public void beginDraggingFrame(JComponent f)
 286     {
 287       delegate.beginDraggingFrame(f);
 288     }
 289
 290     @Override
 291     public void beginResizingFrame(JComponent f, int direction)
 292     {
 293       delegate.beginResizingFrame(f, direction);
 294     }
 295
 296     @Override
 297     public void closeFrame(JInternalFrame f)
 298     {
 299       delegate.closeFrame(f);
 300     }
 301
 302     @Override
 303     public void deactivateFrame(JInternalFrame f)
 304     {
 305       delegate.deactivateFrame(f);
 306     }
 307
 308     @Override
 309     public void deiconifyFrame(JInternalFrame f)
 310     {
 311       delegate.deiconifyFrame(f);
 312     }
 313
 314     @Override
 315     public void dragFrame(JComponent f, int newX, int newY)
 316     {
 317       if (newY < 0)
 318       {
 319         newY = 0;
 320       }
 321       delegate.dragFrame(f, newX, newY);
 322     }
 323
 324     @Override
 325     public void endDraggingFrame(JComponent f)
 326     {
 327       delegate.endDraggingFrame(f);
 328       desktop.repaint();
 329     }
 330
 331     @Override
 332     public void endResizingFrame(JComponent f)
 333     {
 334       delegate.endResizingFrame(f);
 335       desktop.repaint();
 336     }
 337
 338     @Override
 339     public void iconifyFrame(JInternalFrame f)
 340     {
 341       delegate.iconifyFrame(f);
 342     }
 343
 344     @Override
 345     public void maximizeFrame(JInternalFrame f)
 346     {
 347       delegate.maximizeFrame(f);
 348     }
 349
 350     @Override
 351     public void minimizeFrame(JInternalFrame f)
 352     {
 353       delegate.minimizeFrame(f);
 354     }
 355
 356     @Override
 357     public void openFrame(JInternalFrame f)
 358     {
 359       delegate.openFrame(f);
 360     }
 361
 362     @Override
 363     public void resizeFrame(JComponent f, int newX, int newY, int newWidth,
 364             int newHeight)
 365     {
 366       if (newY < 0)
 367       {
 368         newY = 0;
 369       }
 370       delegate.resizeFrame(f, newX, newY, newWidth, newHeight);
 371     }
 372
 373     @Override
 374     public void setBoundsForFrame(JComponent f, int newX, int newY,
 375             int newWidth, int newHeight)
 376     {
 377       delegate.setBoundsForFrame(f, newX, newY, newWidth, newHeight);
 378     }
 379
 380     // All other methods, simply delegate
 381
 382   }
 383
 384   /**
 385    * Creates a new Desktop object.
 386    */
 387   public Desktop()
 388   {
 389     super();
 390     /**
 391      * A note to implementors. It is ESSENTIAL that any activities that might
 392      * block are spawned off as threads rather than waited for during this
 393      * constructor.
 394      */
 395     instance = this;
 396
 397     doConfigureStructurePrefs();
 398     setTitle(ChannelProperties.getProperty("app_name") + " "
 399             + Cache.getProperty("VERSION"));
 400
 401     /**
 402      * Set taskbar "grouped windows" name for linux desktops (works in GNOME and
 403      * KDE). This uses sun.awt.X11.XToolkit.awtAppClassName which is not
 404      * officially documented or guaranteed to exist, so we access it via
 405      * reflection. There appear to be unfathomable criteria about what this
 406      * string can contain, and it if doesn't meet those criteria then "java"
 407      * (KDE) or "jalview-bin-Jalview" (GNOME) is used. "Jalview", "Jalview
 408      * Develop" and "Jalview Test" seem okay, but "Jalview non-release" does
 409      * not. The reflection access may generate a warning: WARNING: An illegal
 410      * reflective access operation has occurred WARNING: Illegal reflective
 411      * access by jalview.gui.Desktop () to field
 412      * sun.awt.X11.XToolkit.awtAppClassName which I don't think can be avoided.
 413      */
 414     if (Platform.isLinux())
 415     {
 416       try
 417       {
 418         Toolkit xToolkit = Toolkit.getDefaultToolkit();
 419         Field[] declaredFields = xToolkit.getClass().getDeclaredFields();
 420         Field awtAppClassNameField = null;
 421
 422         if (Arrays.stream(declaredFields)
 423                 .anyMatch(f -> f.getName().equals("awtAppClassName")))
 424         {
 425           awtAppClassNameField = xToolkit.getClass()
 426                   .getDeclaredField("awtAppClassName");
 427         }
 428
 429         String title = ChannelProperties.getProperty("app_name");
 430         if (awtAppClassNameField != null)
 431         {
 432           awtAppClassNameField.setAccessible(true);
 433           awtAppClassNameField.set(xToolkit, title);
 434         }
 435         else
 436         {
 437           jalview.bin.Console.debug("XToolkit: awtAppClassName not found");
 438         }
 439       } catch (Exception e)
 440       {
 441         jalview.bin.Console.debug("Error setting awtAppClassName");
 442         jalview.bin.Console.trace(Cache.getStackTraceString(e));
 443       }
 444     }
 445
 446     /**
 447      * APQHandlers sets handlers for About, Preferences and Quit actions
 448      * peculiar to macOS's application menu. APQHandlers will check to see if a
 449      * handler is supported before setting it.
 450      */
 451     try
 452     {
 453       APQHandlers.setAPQHandlers(this);
 454     } catch (Exception e)
 455     {
 456       System.out.println("Cannot set APQHandlers");
 457       // e.printStackTrace();
 458     } catch (Throwable t)
 459     {
 460       jalview.bin.Console
 461               .warn("Error setting APQHandlers: " + t.toString());
 462       jalview.bin.Console.trace(Cache.getStackTraceString(t));
 463     }
 464     setIconImages(ChannelProperties.getIconList());
 465
 466     addWindowListener(new WindowAdapter()
 467     {
 468
 469       @Override
 470       public void windowClosing(WindowEvent ev)
 471       {
 472         quit();
 473       }
 474     });
 475
 476     boolean selmemusage = Cache.getDefault("SHOW_MEMUSAGE", false);
 477
 478     boolean showjconsole = Cache.getDefault("SHOW_JAVA_CONSOLE", false);
 479     desktop = new MyDesktopPane(selmemusage);
 480
 481     showMemusage.setSelected(selmemusage);
 482     desktop.setBackground(Color.white);
 483
 484     this.setIconImages(ChannelProperties.getIconList());
 485
 486     getContentPane().setLayout(new BorderLayout());
 487     // alternate config - have scrollbars - see notes in JAL-153
 488     // JScrollPane sp = new JScrollPane();
 489     // sp.getViewport().setView(desktop);
 490     // getContentPane().add(sp, BorderLayout.CENTER);
 491
 492     // BH 2018 - just an experiment to try unclipped JInternalFrames.
 493     if (Platform.isJS())
 494     {
 495       getRootPane().putClientProperty("swingjs.overflow.hidden", "false");
 496     }
 497
 498     getContentPane().add(desktop, BorderLayout.CENTER);
 499     desktop.setDragMode(JDesktopPane.OUTLINE_DRAG_MODE);
 500
 501     // This line prevents Windows Look&Feel resizing all new windows to maximum
 502     // if previous window was maximised
 503     desktop.setDesktopManager(new MyDesktopManager(
 504             (Platform.isWindowsAndNotJS() ? new DefaultDesktopManager()
 505                     : Platform.isAMacAndNotJS()
 506                             ? new AquaInternalFrameManager(
 507                                     desktop.getDesktopManager())
 508                             : desktop.getDesktopManager())));
 509
 510     Rectangle dims = getLastKnownDimensions("");
 511     if (dims != null)
 512     {
 513       setBounds(dims);
 514     }
 515     else
 516     {
 517       Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
 518       int xPos = Math.max(5, (screenSize.width - 900) / 2);
 519       int yPos = Math.max(5, (screenSize.height - 650) / 2);
 520       setBounds(xPos, yPos, 900, 650);
 521     }
 522
 523     if (!Platform.isJS())
 524     /**
 525      * Java only
 526      *
 527      * @j2sIgnore
 528      */
 529     {
 530       jconsole = new Console(this, showjconsole);
 531       jconsole.setHeader(Cache.getVersionDetailsForConsole());
 532       showConsole(showjconsole);
 533
 534       showNews.setVisible(false);
 535
 536       experimentalFeatures.setSelected(showExperimental());
 537
 538       getIdentifiersOrgData();
 539
 540       checkURLLinks();
 541
 542       // Spawn a thread that shows the splashscreen
 543       if (!nosplash)
 544       {
 545         SwingUtilities.invokeLater(new Runnable()
 546         {
 547           @Override
 548           public void run()
 549           {
 550             new SplashScreen(true);
 551           }
 552         });
 553       }
 554
 555       // Thread off a new instance of the file chooser - this reduces the time
 556       // it
 557       // takes to open it later on.
 558       new Thread(new Runnable()
 559       {
 560         @Override
 561         public void run()
 562         {
 563           jalview.bin.Console.debug("Filechooser init thread started.");
 564           String fileFormat = Cache.getProperty("DEFAULT_FILE_FORMAT");
 565           JalviewFileChooser.forRead(Cache.getProperty("LAST_DIRECTORY"),
 566                   fileFormat);
 567           jalview.bin.Console.debug("Filechooser init thread finished.");
 568         }
 569       }).start();
 570       // Add the service change listener
 571       changeSupport.addJalviewPropertyChangeListener("services",
 572               new PropertyChangeListener()
 573               {
 574
 575                 @Override
 576                 public void propertyChange(PropertyChangeEvent evt)
 577                 {
 578                   jalview.bin.Console
 579                           .debug("Firing service changed event for "
 580                                   + evt.getNewValue());
 581                   JalviewServicesChanged(evt);
 582                 }
 583               });
 584     }
 585
 586     this.setDropTarget(new java.awt.dnd.DropTarget(desktop, this));
 587
 588     this.addWindowListener(new WindowAdapter()
 589     {
 590       @Override
 591       public void windowClosing(WindowEvent evt)
 592       {
 593         quit();
 594       }
 595     });
 596
 597     MouseAdapter ma;
 598     this.addMouseListener(ma = new MouseAdapter()
 599     {
 600       @Override
 601       public void mousePressed(MouseEvent evt)
 602       {
 603         if (evt.isPopupTrigger()) // Mac
 604         {
 605           showPasteMenu(evt.getX(), evt.getY());
 606         }
 607       }
 608
 609       @Override
 610       public void mouseReleased(MouseEvent evt)
 611       {
 612         if (evt.isPopupTrigger()) // Windows
 613         {
 614           showPasteMenu(evt.getX(), evt.getY());
 615         }
 616       }
 617     });
 618     desktop.addMouseListener(ma);
 619   }
 620
 621   /**
 622    * Answers true if user preferences to enable experimental features is True
 623    * (on), else false
 624    *
 625    * @return
 626    */
 627   public boolean showExperimental()
 628   {
 629     String experimental = Cache.getDefault(EXPERIMENTAL_FEATURES,
 630             Boolean.FALSE.toString());
 631     return Boolean.valueOf(experimental).booleanValue();
 632   }
 633
 634   public void doConfigureStructurePrefs()
 635   {
 636     // configure services
 637     StructureSelectionManager ssm = StructureSelectionManager
 638             .getStructureSelectionManager(this);
 639     if (Cache.getDefault(Preferences.ADD_SS_ANN, true))
 640     {
 641       ssm.setAddTempFacAnnot(
 642               Cache.getDefault(Preferences.ADD_TEMPFACT_ANN, true));
 643       ssm.setProcessSecondaryStructure(
 644               Cache.getDefault(Preferences.STRUCT_FROM_PDB, true));
 645       // JAL-3915 - RNAView is no longer an option so this has no effect
 646       ssm.setSecStructServices(
 647               Cache.getDefault(Preferences.USE_RNAVIEW, false));
 648     }
 649     else
 650     {
 651       ssm.setAddTempFacAnnot(false);
 652       ssm.setProcessSecondaryStructure(false);
 653       ssm.setSecStructServices(false);
 654     }
 655   }
 656
 657   public void checkForNews()
 658   {
 659     final Desktop me = this;
 660     // Thread off the news reader, in case there are connection problems.
 661     new Thread(new Runnable()
 662     {
 663       @Override
 664       public void run()
 665       {
 666         jalview.bin.Console.debug("Starting news thread.");
 667         jvnews = new BlogReader(me);
 668         showNews.setVisible(true);
 669         jalview.bin.Console.debug("Completed news thread.");
 670       }
 671     }).start();
 672   }
 673
 674   public void getIdentifiersOrgData()
 675   {
 676     if (Cache.getProperty("NOIDENTIFIERSSERVICE") == null)
 677     {// Thread off the identifiers fetcher
 678       new Thread(new Runnable()
 679       {
 680         @Override
 681         public void run()
 682         {
 683           jalview.bin.Console
 684                   .debug("Downloading data from identifiers.org");
 685           try
 686           {
 687             UrlDownloadClient.download(IdOrgSettings.getUrl(),
 688                     IdOrgSettings.getDownloadLocation());
 689           } catch (IOException e)
 690           {
 691             jalview.bin.Console
 692                     .debug("Exception downloading identifiers.org data"
 693                             + e.getMessage());
 694           }
 695         }
 696       }).start();
 697       ;
 698     }
 699   }
 700
 701   @Override
 702   protected void showNews_actionPerformed(ActionEvent e)
 703   {
 704     showNews(showNews.isSelected());
 705   }
 706
 707   void showNews(boolean visible)
 708   {
 709     jalview.bin.Console.debug((visible ? "Showing" : "Hiding") + " news.");
 710     showNews.setSelected(visible);
 711     if (visible && !jvnews.isVisible())
 712     {
 713       new Thread(new Runnable()
 714       {
 715         @Override
 716         public void run()
 717         {
 718           long now = System.currentTimeMillis();
 719           Desktop.instance.setProgressBar(
 720                   MessageManager.getString("status.refreshing_news"), now);
 721           jvnews.refreshNews();
 722           Desktop.instance.setProgressBar(null, now);
 723           jvnews.showNews();
 724         }
 725       }).start();
 726     }
 727   }
 728
 729   /**
 730    * recover the last known dimensions for a jalview window
 731    *
 732    * @param windowName
 733    *          - empty string is desktop, all other windows have unique prefix
 734    * @return null or last known dimensions scaled to current geometry (if last
 735    *         window geom was known)
 736    */
 737   Rectangle getLastKnownDimensions(String windowName)
 738   {
 739     // TODO: lock aspect ratio for scaling desktop Bug #0058199
 740     Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
 741     String x = Cache.getProperty(windowName + "SCREEN_X");
 742     String y = Cache.getProperty(windowName + "SCREEN_Y");
 743     String width = Cache.getProperty(windowName + "SCREEN_WIDTH");
 744     String height = Cache.getProperty(windowName + "SCREEN_HEIGHT");
 745     if ((x != null) && (y != null) && (width != null) && (height != null))
 746     {
 747       int ix = Integer.parseInt(x), iy = Integer.parseInt(y),
 748               iw = Integer.parseInt(width), ih = Integer.parseInt(height);
 749       if (Cache.getProperty("SCREENGEOMETRY_WIDTH") != null)
 750       {
 751         // attempt #1 - try to cope with change in screen geometry - this
 752         // version doesn't preserve original jv aspect ratio.
 753         // take ratio of current screen size vs original screen size.
 754         double sw = ((1f * screenSize.width) / (1f * Integer
 755                 .parseInt(Cache.getProperty("SCREENGEOMETRY_WIDTH"))));
 756         double sh = ((1f * screenSize.height) / (1f * Integer
 757                 .parseInt(Cache.getProperty("SCREENGEOMETRY_HEIGHT"))));
 758         // rescale the bounds depending upon the current screen geometry.
 759         ix = (int) (ix * sw);
 760         iw = (int) (iw * sw);
 761         iy = (int) (iy * sh);
 762         ih = (int) (ih * sh);
 763         while (ix >= screenSize.width)
 764         {
 765           jalview.bin.Console.debug(
 766                   "Window geometry location recall error: shifting horizontal to within screenbounds.");
 767           ix -= screenSize.width;
 768         }
 769         while (iy >= screenSize.height)
 770         {
 771           jalview.bin.Console.debug(
 772                   "Window geometry location recall error: shifting vertical to within screenbounds.");
 773           iy -= screenSize.height;
 774         }
 775         jalview.bin.Console.debug(
 776                 "Got last known dimensions for " + windowName + ": x:" + ix
 777                         + " y:" + iy + " width:" + iw + " height:" + ih);
 778       }
 779       // return dimensions for new instance
 780       return new Rectangle(ix, iy, iw, ih);
 781     }
 782     return null;
 783   }
 784
 785   void showPasteMenu(int x, int y)
 786   {
 787     JPopupMenu popup = new JPopupMenu();
 788     JMenuItem item = new JMenuItem(
 789             MessageManager.getString("label.paste_new_window"));
 790     item.addActionListener(new ActionListener()
 791     {
 792       @Override
 793       public void actionPerformed(ActionEvent evt)
 794       {
 795         paste();
 796       }
 797     });
 798
 799     popup.add(item);
 800     popup.show(this, x, y);
 801   }
 802
 803   public void paste()
 804   {
 805     try
 806     {
 807       Clipboard c = Toolkit.getDefaultToolkit().getSystemClipboard();
 808       Transferable contents = c.getContents(this);
 809
 810       if (contents != null)
 811       {
 812         String file = (String) contents
 813                 .getTransferData(DataFlavor.stringFlavor);
 814
 815         FileFormatI format = new IdentifyFile().identify(file,
 816                 DataSourceType.PASTE);
 817
 818         new FileLoader().LoadFile(file, DataSourceType.PASTE, format);
 819
 820       }
 821     } catch (Exception ex)
 822     {
 823       System.out.println(
 824               "Unable to paste alignment from system clipboard:\n" + ex);
 825     }
 826   }
 827
 828   /**
 829    * Adds and opens the given frame to the desktop
 830    *
 831    * @param frame
 832    *          Frame to show
 833    * @param title
 834    *          Visible Title
 835    * @param w
 836    *          width
 837    * @param h
 838    *          height
 839    */
 840   public static synchronized void addInternalFrame(
 841           final JInternalFrame frame, String title, int w, int h)
 842   {
 843     addInternalFrame(frame, title, true, w, h, true, false);
 844   }
 845
 846   /**
 847    * Add an internal frame to the Jalview desktop
 848    *
 849    * @param frame
 850    *          Frame to show
 851    * @param title
 852    *          Visible Title
 853    * @param makeVisible
 854    *          When true, display frame immediately, otherwise, caller must call
 855    *          setVisible themselves.
 856    * @param w
 857    *          width
 858    * @param h
 859    *          height
 860    */
 861   public static synchronized void addInternalFrame(
 862           final JInternalFrame frame, String title, boolean makeVisible,
 863           int w, int h)
 864   {
 865     addInternalFrame(frame, title, makeVisible, w, h, true, false);
 866   }
 867
 868   /**
 869    * Add an internal frame to the Jalview desktop and make it visible
 870    *
 871    * @param frame
 872    *          Frame to show
 873    * @param title
 874    *          Visible Title
 875    * @param w
 876    *          width
 877    * @param h
 878    *          height
 879    * @param resizable
 880    *          Allow resize
 881    */
 882   public static synchronized void addInternalFrame(
 883           final JInternalFrame frame, String title, int w, int h,
 884           boolean resizable)
 885   {
 886     addInternalFrame(frame, title, true, w, h, resizable, false);
 887   }
 888
 889   /**
 890    * Add an internal frame to the Jalview desktop
 891    *
 892    * @param frame
 893    *          Frame to show
 894    * @param title
 895    *          Visible Title
 896    * @param makeVisible
 897    *          When true, display frame immediately, otherwise, caller must call
 898    *          setVisible themselves.
 899    * @param w
 900    *          width
 901    * @param h
 902    *          height
 903    * @param resizable
 904    *          Allow resize
 905    * @param ignoreMinSize
 906    *          Do not set the default minimum size for frame
 907    */
 908   public static synchronized void addInternalFrame(
 909           final JInternalFrame frame, String title, boolean makeVisible,
 910           int w, int h, boolean resizable, boolean ignoreMinSize)
 911   {
 912
 913     // TODO: allow callers to determine X and Y position of frame (eg. via
 914     // bounds object).
 915     // TODO: consider fixing method to update entries in the window submenu with
 916     // the current window title
 917
 918     frame.setTitle(title);
 919     if (frame.getWidth() < 1 || frame.getHeight() < 1)
 920     {
 921       frame.setSize(w, h);
 922     }
 923     // THIS IS A PUBLIC STATIC METHOD, SO IT MAY BE CALLED EVEN IN
 924     // A HEADLESS STATE WHEN NO DESKTOP EXISTS. MUST RETURN
 925     // IF JALVIEW IS RUNNING HEADLESS
 926     // ///////////////////////////////////////////////
 927     if (instance == null || (System.getProperty("java.awt.headless") != null
 928             && System.getProperty("java.awt.headless").equals("true")))
 929     {
 930       return;
 931     }
 932
 933     openFrameCount++;
 934
 935     if (!ignoreMinSize)
 936     {
 937       frame.setMinimumSize(
 938               new Dimension(DEFAULT_MIN_WIDTH, DEFAULT_MIN_HEIGHT));
 939
 940       // Set default dimension for Alignment Frame window.
 941       // The Alignment Frame window could be added from a number of places,
 942       // hence,
 943       // I did this here in order not to miss out on any Alignment frame.
 944       if (frame instanceof AlignFrame)
 945       {
 946         frame.setMinimumSize(new Dimension(ALIGN_FRAME_DEFAULT_MIN_WIDTH,
 947                 ALIGN_FRAME_DEFAULT_MIN_HEIGHT));
 948       }
 949     }
 950
 951     frame.setVisible(makeVisible);
 952     frame.setClosable(true);
 953     frame.setResizable(resizable);
 954     frame.setMaximizable(resizable);
 955     frame.setIconifiable(resizable);
 956     frame.setOpaque(Platform.isJS());
 957
 958     if (frame.getX() < 1 && frame.getY() < 1)
 959     {
 960       frame.setLocation(xOffset * openFrameCount,
 961               yOffset * ((openFrameCount - 1) % 10) + yOffset);
 962     }
 963
 964     /*
 965      * add an entry for the new frame in the Window menu (and remove it when the
 966      * frame is closed)
 967      */
 968     final JMenuItem menuItem = new JMenuItem(title);
 969     frame.addInternalFrameListener(new InternalFrameAdapter()
 970     {
 971       @Override
 972       public void internalFrameActivated(InternalFrameEvent evt)
 973       {
 974         JInternalFrame itf = desktop.getSelectedFrame();
 975         if (itf != null)
 976         {
 977           if (itf instanceof AlignFrame)
 978           {
 979             Jalview.setCurrentAlignFrame((AlignFrame) itf);
 980           }
 981           itf.requestFocus();
 982         }
 983       }
 984
 985       @Override
 986       public void internalFrameClosed(InternalFrameEvent evt)
 987       {
 988         PaintRefresher.RemoveComponent(frame);
 989
 990         /*
 991          * defensive check to prevent frames being added half off the window
 992          */
 993         if (openFrameCount > 0)
 994         {
 995           openFrameCount--;
 996         }
 997
 998         /*
 999          * ensure no reference to alignFrame retained by menu item listener
1000          */
1001         if (menuItem.getActionListeners().length > 0)
1002         {
1003           menuItem.removeActionListener(menuItem.getActionListeners()[0]);
1004         }
1005         windowMenu.remove(menuItem);
1006       }
1007     });
1008
1009     menuItem.addActionListener(new ActionListener()
1010     {
1011       @Override
1012       public void actionPerformed(ActionEvent e)
1013       {
1014         try
1015         {
1016           frame.setSelected(true);
1017           frame.setIcon(false);
1018         } catch (java.beans.PropertyVetoException ex)
1019         {
1020           // System.err.println(ex.toString());
1021         }
1022       }
1023     });
1024
1025     setKeyBindings(frame);
1026
1027     desktop.add(frame);
1028
1029     windowMenu.add(menuItem);
1030
1031     frame.toFront();
1032     try
1033     {
1034       frame.setSelected(true);
1035       frame.requestFocus();
1036     } catch (java.beans.PropertyVetoException ve)
1037     {
1038     } catch (java.lang.ClassCastException cex)
1039     {
1040       jalview.bin.Console.warn(
1041               "Squashed a possible GUI implementation error. If you can recreate this, please look at https://issues.jalview.org/browse/JAL-869",
1042               cex);
1043     }
1044   }
1045
1046   /**
1047    * Add key bindings to a JInternalFrame so that Ctrl-W and Cmd-W will close
1048    * the window
1049    *
1050    * @param frame
1051    */
1052   private static void setKeyBindings(JInternalFrame frame)
1053   {
1054     @SuppressWarnings("serial")
1055     final Action closeAction = new AbstractAction()
1056     {
1057       @Override
1058       public void actionPerformed(ActionEvent e)
1059       {
1060         frame.dispose();
1061       }
1062     };
1063
1064     /*
1065      * set up key bindings for Ctrl-W and Cmd-W, with the same (Close) action
1066      */
1067     KeyStroke ctrlWKey = KeyStroke.getKeyStroke(KeyEvent.VK_W,
1068             InputEvent.CTRL_DOWN_MASK);
1069     KeyStroke cmdWKey = KeyStroke.getKeyStroke(KeyEvent.VK_W,
1070             ShortcutKeyMaskExWrapper.getMenuShortcutKeyMaskEx());
1071
1072     InputMap inputMap = frame
1073             .getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW);
1074     String ctrlW = ctrlWKey.toString();
1075     inputMap.put(ctrlWKey, ctrlW);
1076     inputMap.put(cmdWKey, ctrlW);
1077
1078     ActionMap actionMap = frame.getActionMap();
1079     actionMap.put(ctrlW, closeAction);
1080   }
1081
1082   @Override
1083   public void lostOwnership(Clipboard clipboard, Transferable contents)
1084   {
1085     if (!internalCopy)
1086     {
1087       Desktop.jalviewClipboard = null;
1088     }
1089
1090     internalCopy = false;
1091   }
1092
1093   @Override
1094   public void dragEnter(DropTargetDragEvent evt)
1095   {
1096   }
1097
1098   @Override
1099   public void dragExit(DropTargetEvent evt)
1100   {
1101   }
1102
1103   @Override
1104   public void dragOver(DropTargetDragEvent evt)
1105   {
1106   }
1107
1108   @Override
1109   public void dropActionChanged(DropTargetDragEvent evt)
1110   {
1111   }
1112
1113   /**
1114    * DOCUMENT ME!
1115    *
1116    * @param evt
1117    *          DOCUMENT ME!
1118    */
1119   @Override
1120   public void drop(DropTargetDropEvent evt)
1121   {
1122     boolean success = true;
1123     // JAL-1552 - acceptDrop required before getTransferable call for
1124     // Java's Transferable for native dnd
1125     evt.acceptDrop(DnDConstants.ACTION_COPY_OR_MOVE);
1126     Transferable t = evt.getTransferable();
1127     List<Object> files = new ArrayList<>();
1128     List<DataSourceType> protocols = new ArrayList<>();
1129
1130     try
1131     {
1132       Desktop.transferFromDropTarget(files, protocols, evt, t);
1133     } catch (Exception e)
1134     {
1135       e.printStackTrace();
1136       success = false;
1137     }
1138
1139     if (files != null)
1140     {
1141       try
1142       {
1143         for (int i = 0; i < files.size(); i++)
1144         {
1145           // BH 2018 File or String
1146           Object file = files.get(i);
1147           String fileName = file.toString();
1148           DataSourceType protocol = (protocols == null)
1149                   ? DataSourceType.FILE
1150                   : protocols.get(i);
1151           FileFormatI format = null;
1152
1153           if (fileName.toLowerCase(Locale.ROOT).endsWith(".jar"))
1154           {
1155             format = FileFormat.Jalview;
1156
1157           }
1158           else
1159           {
1160             format = new IdentifyFile().identify(file, protocol);
1161           }
1162           if (file instanceof File)
1163           {
1164             Platform.cacheFileData((File) file);
1165           }
1166           new FileLoader().LoadFile(null, file, protocol, format);
1167
1168         }
1169       } catch (Exception ex)
1170       {
1171         success = false;
1172       }
1173     }
1174     evt.dropComplete(success); // need this to ensure input focus is properly
1175                                // transfered to any new windows created
1176   }
1177
1178   /**
1179    * DOCUMENT ME!
1180    *
1181    * @param e
1182    *          DOCUMENT ME!
1183    */
1184   @Override
1185   public void inputLocalFileMenuItem_actionPerformed(AlignViewport viewport)
1186   {
1187     String fileFormat = Cache.getProperty("DEFAULT_FILE_FORMAT");
1188     JalviewFileChooser chooser = JalviewFileChooser.forRead(
1189             Cache.getProperty("LAST_DIRECTORY"), fileFormat,
1190             BackupFiles.getEnabled());
1191
1192     chooser.setFileView(new JalviewFileView());
1193     chooser.setDialogTitle(
1194             MessageManager.getString("label.open_local_file"));
1195     chooser.setToolTipText(MessageManager.getString("action.open"));
1196
1197     chooser.setResponseHandler(0, new Runnable()
1198     {
1199       @Override
1200       public void run()
1201       {
1202         File selectedFile = chooser.getSelectedFile();
1203         Cache.setProperty("LAST_DIRECTORY", selectedFile.getParent());
1204
1205         FileFormatI format = chooser.getSelectedFormat();
1206         openFile(selectedFile, format, viewport);
1207       }
1208     });
1209     chooser.showOpenDialog(this);
1210   }
1211
1212   public void openFile(File selectedFile, FileFormatI format,
1213           AlignViewport viewport)
1214   {
1215
1216     /*
1217      * Call IdentifyFile to verify the file contains what its extension implies.
1218      * Skip this step for dynamically added file formats, because
1219      * IdentifyFile does not know how to recognise them.
1220      */
1221     if (FileFormats.getInstance().isIdentifiable(format))
1222     {
1223       try
1224       {
1225         format = new IdentifyFile().identify(selectedFile,
1226                 DataSourceType.FILE);
1227       } catch (FileFormatException e)
1228       {
1229         // format = null; //??
1230       }
1231     }
1232
1233     new FileLoader().LoadFile(viewport, selectedFile, DataSourceType.FILE,
1234             format);
1235   }
1236
1237   /**
1238    * Shows a dialog for input of a URL at which to retrieve alignment data
1239    *
1240    * @param viewport
1241    */
1242   @Override
1243   public void inputURLMenuItem_actionPerformed(AlignViewport viewport)
1244   {
1245     // This construct allows us to have a wider textfield
1246     // for viewing
1247     JLabel label = new JLabel(
1248             MessageManager.getString("label.input_file_url"));
1249
1250     JPanel panel = new JPanel(new GridLayout(2, 1));
1251     panel.add(label);
1252
1253     /*
1254      * the URL to fetch is input in Java: an editable combobox with history JS:
1255      * (pending JAL-3038) a plain text field
1256      */
1257     JComponent history;
1258     String urlBase = "https://www.";
1259     if (Platform.isJS())
1260     {
1261       history = new JTextField(urlBase, 35);
1262     }
1263     else
1264     /**
1265      * Java only
1266      *
1267      * @j2sIgnore
1268      */
1269     {
1270       JComboBox<String> asCombo = new JComboBox<>();
1271       asCombo.setPreferredSize(new Dimension(400, 20));
1272       asCombo.setEditable(true);
1273       asCombo.addItem(urlBase);
1274       String historyItems = Cache.getProperty("RECENT_URL");
1275       if (historyItems != null)
1276       {
1277         for (String token : historyItems.split("\\t"))
1278         {
1279           asCombo.addItem(token);
1280         }
1281       }
1282       history = asCombo;
1283     }
1284     panel.add(history);
1285
1286     Object[] options = new Object[] { MessageManager.getString("action.ok"),
1287         MessageManager.getString("action.cancel") };
1288     Runnable action = new Runnable()
1289     {
1290       @Override
1291       public void run()
1292       {
1293         @SuppressWarnings("unchecked")
1294         String url = (history instanceof JTextField
1295                 ? ((JTextField) history).getText()
1296                 : ((JComboBox<String>) history).getEditor().getItem()
1297                         .toString().trim());
1298
1299         if (!loadUrl(url, viewport))
1300         {
1301           String msg = MessageManager.formatMessage("label.couldnt_locate",
1302                   url);
1303           JvOptionPane.showInternalMessageDialog(Desktop.desktop, msg,
1304                   MessageManager.getString("label.url_not_found"),
1305                   JvOptionPane.WARNING_MESSAGE);
1306         }
1307       }
1308     };
1309     String dialogOption = MessageManager
1310             .getString("label.input_alignment_from_url");
1311     JvOptionPane.newOptionDialog(desktop).setResponseHandler(0, action)
1312             .showInternalDialog(panel, dialogOption,
1313                     JvOptionPane.YES_NO_CANCEL_OPTION,
1314                     JvOptionPane.PLAIN_MESSAGE, null, options,
1315                     MessageManager.getString("action.ok"));
1316   }
1317
1318   public boolean loadUrl(String url, AlignViewport viewport)
1319   {
1320     if (url.toLowerCase(Locale.ROOT).endsWith(".jar"))
1321     {
1322       if (viewport != null)
1323       {
1324         new FileLoader().LoadFile(viewport, url, DataSourceType.URL,
1325                 FileFormat.Jalview);
1326       }
1327       else
1328       {
1329         new FileLoader().LoadFile(url, DataSourceType.URL,
1330                 FileFormat.Jalview);
1331       }
1332     }
1333     else
1334     {
1335       FileFormatI format = null;
1336       try
1337       {
1338         format = new IdentifyFile().identify(url, DataSourceType.URL);
1339       } catch (FileFormatException e)
1340       {
1341         // TODO revise error handling, distinguish between
1342         // URL not found and response not valid
1343       }
1344
1345       if (format == null)
1346       {
1347
1348         return false;
1349       }
1350
1351       if (viewport != null)
1352       {
1353         new FileLoader().LoadFile(viewport, url, DataSourceType.URL,
1354                 format);
1355       }
1356       else
1357       {
1358         new FileLoader().LoadFile(url, DataSourceType.URL, format);
1359       }
1360     }
1361     return true;
1362   }
1363
1364   /**
1365    * Opens the CutAndPaste window for the user to paste an alignment in to
1366    *
1367    * @param viewPanel
1368    *          - if not null, the pasted alignment is added to the current
1369    *          alignment; if null, to a new alignment window
1370    */
1371   @Override
1372   public void inputTextboxMenuItem_actionPerformed(
1373           AlignmentViewPanel viewPanel)
1374   {
1375     CutAndPasteTransfer cap = new CutAndPasteTransfer();
1376     cap.setForInput(viewPanel);
1377     Desktop.addInternalFrame(cap,
1378             MessageManager.getString("label.cut_paste_alignmen_file"), true,
1379             600, 500);
1380   }
1381
1382   /*
1383    * Exit the program
1384    */
1385   @Override
1386   public void quit()
1387   {
1388     Dimension screen = Toolkit.getDefaultToolkit().getScreenSize();
1389     Cache.setProperty("SCREENGEOMETRY_WIDTH", screen.width + "");
1390     Cache.setProperty("SCREENGEOMETRY_HEIGHT", screen.height + "");
1391     storeLastKnownDimensions("", new Rectangle(getBounds().x, getBounds().y,
1392             getWidth(), getHeight()));
1393
1394     if (jconsole != null)
1395     {
1396       storeLastKnownDimensions("JAVA_CONSOLE_", jconsole.getBounds());
1397       jconsole.stopConsole();
1398     }
1399     if (jvnews != null)
1400     {
1401       storeLastKnownDimensions("JALVIEW_RSS_WINDOW_", jvnews.getBounds());
1402
1403     }
1404     if (dialogExecutor != null)
1405     {
1406       dialogExecutor.shutdownNow();
1407     }
1408     closeAll_actionPerformed(null);
1409
1410     if (groovyConsole != null)
1411     {
1412       // suppress a possible repeat prompt to save script
1413       groovyConsole.setDirty(false);
1414       groovyConsole.exit();
1415     }
1416     System.exit(0);
1417   }
1418
1419   private void storeLastKnownDimensions(String string, Rectangle jc)
1420   {
1421     jalview.bin.Console.debug("Storing last known dimensions for " + string
1422             + ": x:" + jc.x + " y:" + jc.y + " width:" + jc.width
1423             + " height:" + jc.height);
1424
1425     Cache.setProperty(string + "SCREEN_X", jc.x + "");
1426     Cache.setProperty(string + "SCREEN_Y", jc.y + "");
1427     Cache.setProperty(string + "SCREEN_WIDTH", jc.width + "");
1428     Cache.setProperty(string + "SCREEN_HEIGHT", jc.height + "");
1429   }
1430
1431   /**
1432    * DOCUMENT ME!
1433    *
1434    * @param e
1435    *          DOCUMENT ME!
1436    */
1437   @Override
1438   public void aboutMenuItem_actionPerformed(ActionEvent e)
1439   {
1440     new Thread(new Runnable()
1441     {
1442       @Override
1443       public void run()
1444       {
1445         new SplashScreen(false);
1446       }
1447     }).start();
1448   }
1449
1450   /**
1451    * Returns the html text for the About screen, including any available version
1452    * number, build details, author details and citation reference, but without
1453    * the enclosing {@code html} tags
1454    *
1455    * @return
1456    */
1457   public String getAboutMessage()
1458   {
1459     StringBuilder message = new StringBuilder(1024);
1460     message.append("<div style=\"font-family: sans-serif;\">")
1461             .append("<h1><strong>Version: ")
1462             .append(Cache.getProperty("VERSION")).append("</strong></h1>")
1463             .append("<strong>Built: <em>")
1464             .append(Cache.getDefault("BUILD_DATE", "unknown"))
1465             .append("</em> from ").append(Cache.getBuildDetailsForSplash())
1466             .append("</strong>");
1467
1468     String latestVersion = Cache.getDefault("LATEST_VERSION", "Checking");
1469     if (latestVersion.equals("Checking"))
1470     {
1471       // JBP removed this message for 2.11: May be reinstated in future version
1472       // message.append("<br>...Checking latest version...</br>");
1473     }
1474     else if (!latestVersion.equals(Cache.getProperty("VERSION")))
1475     {
1476       boolean red = false;
1477       if (Cache.getProperty("VERSION").toLowerCase(Locale.ROOT)
1478               .indexOf("automated build") == -1)
1479       {
1480         red = true;
1481         // Displayed when code version and jnlp version do not match and code
1482         // version is not a development build
1483         message.append("<div style=\"color: #FF0000;font-style: bold;\">");
1484       }
1485
1486       message.append("<br>!! Version ")
1487               .append(Cache.getDefault("LATEST_VERSION", "..Checking.."))
1488               .append(" is available for download from ")
1489               .append(Cache.getDefault("www.jalview.org",
1490                       "https://www.jalview.org"))
1491               .append(" !!");
1492       if (red)
1493       {
1494         message.append("</div>");
1495       }
1496     }
1497     message.append("<br>Authors:  ");
1498     message.append(Cache.getDefault("AUTHORFNAMES", DEFAULT_AUTHORS));
1499     message.append(CITATION);
1500
1501     message.append("</div>");
1502
1503     return message.toString();
1504   }
1505
1506   /**
1507    * Action on requesting Help documentation
1508    */
1509   @Override
1510   public void documentationMenuItem_actionPerformed()
1511   {
1512     try
1513     {
1514       if (Platform.isJS())
1515       {
1516         BrowserLauncher.openURL("https://www.jalview.org/help.html");
1517       }
1518       else
1519       /**
1520        * Java only
1521        *
1522        * @j2sIgnore
1523        */
1524       {
1525         Help.showHelpWindow();
1526       }
1527     } catch (Exception ex)
1528     {
1529       System.err.println("Error opening help: " + ex.getMessage());
1530     }
1531   }
1532
1533   @Override
1534   public void closeAll_actionPerformed(ActionEvent e)
1535   {
1536     // TODO show a progress bar while closing?
1537     JInternalFrame[] frames = desktop.getAllFrames();
1538     for (int i = 0; i < frames.length; i++)
1539     {
1540       try
1541       {
1542         frames[i].setClosed(true);
1543       } catch (java.beans.PropertyVetoException ex)
1544       {
1545       }
1546     }
1547     Jalview.setCurrentAlignFrame(null);
1548     System.out.println("ALL CLOSED");
1549
1550     /*
1551      * reset state of singleton objects as appropriate (clear down session state
1552      * when all windows are closed)
1553      */
1554     StructureSelectionManager ssm = StructureSelectionManager
1555             .getStructureSelectionManager(this);
1556     if (ssm != null)
1557     {
1558       ssm.resetAll();
1559     }
1560   }
1561
1562   @Override
1563   public void raiseRelated_actionPerformed(ActionEvent e)
1564   {
1565     reorderAssociatedWindows(false, false);
1566   }
1567
1568   @Override
1569   public void minimizeAssociated_actionPerformed(ActionEvent e)
1570   {
1571     reorderAssociatedWindows(true, false);
1572   }
1573
1574   void closeAssociatedWindows()
1575   {
1576     reorderAssociatedWindows(false, true);
1577   }
1578
1579   /*
1580    * (non-Javadoc)
1581    *
1582    * @seejalview.jbgui.GDesktop#garbageCollect_actionPerformed(java.awt.event.
1583    * ActionEvent)
1584    */
1585   @Override
1586   protected void garbageCollect_actionPerformed(ActionEvent e)
1587   {
1588     // We simply collect the garbage
1589     jalview.bin.Console.debug("Collecting garbage...");
1590     System.gc();
1591     jalview.bin.Console.debug("Finished garbage collection.");
1592   }
1593
1594   /*
1595    * (non-Javadoc)
1596    *
1597    * @see jalview.jbgui.GDesktop#showMemusage_actionPerformed(java.awt.event.
1598    * ActionEvent )
1599    */
1600   @Override
1601   protected void showMemusage_actionPerformed(ActionEvent e)
1602   {
1603     desktop.showMemoryUsage(showMemusage.isSelected());
1604   }
1605
1606   /*
1607    * (non-Javadoc)
1608    *
1609    * @see
1610    * jalview.jbgui.GDesktop#showConsole_actionPerformed(java.awt.event.ActionEvent
1611    * )
1612    */
1613   @Override
1614   protected void showConsole_actionPerformed(ActionEvent e)
1615   {
1616     showConsole(showConsole.isSelected());
1617   }
1618
1619   Console jconsole = null;
1620
1621   /**
1622    * control whether the java console is visible or not
1623    *
1624    * @param selected
1625    */
1626   void showConsole(boolean selected)
1627   {
1628     // TODO: decide if we should update properties file
1629     if (jconsole != null) // BH 2018
1630     {
1631       showConsole.setSelected(selected);
1632       Cache.setProperty("SHOW_JAVA_CONSOLE",
1633               Boolean.valueOf(selected).toString());
1634       jconsole.setVisible(selected);
1635     }
1636   }
1637
1638   void reorderAssociatedWindows(boolean minimize, boolean close)
1639   {
1640     JInternalFrame[] frames = desktop.getAllFrames();
1641     if (frames == null || frames.length < 1)
1642     {
1643       return;
1644     }
1645
1646     AlignmentViewport source = null, target = null;
1647     if (frames[0] instanceof AlignFrame)
1648     {
1649       source = ((AlignFrame) frames[0]).getCurrentView();
1650     }
1651     else if (frames[0] instanceof TreePanel)
1652     {
1653       source = ((TreePanel) frames[0]).getViewPort();
1654     }
1655     else if (frames[0] instanceof PCAPanel)
1656     {
1657       source = ((PCAPanel) frames[0]).av;
1658     }
1659     else if (frames[0].getContentPane() instanceof PairwiseAlignPanel)
1660     {
1661       source = ((PairwiseAlignPanel) frames[0].getContentPane()).av;
1662     }
1663
1664     if (source != null)
1665     {
1666       for (int i = 0; i < frames.length; i++)
1667       {
1668         target = null;
1669         if (frames[i] == null)
1670         {
1671           continue;
1672         }
1673         if (frames[i] instanceof AlignFrame)
1674         {
1675           target = ((AlignFrame) frames[i]).getCurrentView();
1676         }
1677         else if (frames[i] instanceof TreePanel)
1678         {
1679           target = ((TreePanel) frames[i]).getViewPort();
1680         }
1681         else if (frames[i] instanceof PCAPanel)
1682         {
1683           target = ((PCAPanel) frames[i]).av;
1684         }
1685         else if (frames[i].getContentPane() instanceof PairwiseAlignPanel)
1686         {
1687           target = ((PairwiseAlignPanel) frames[i].getContentPane()).av;
1688         }
1689
1690         if (source == target)
1691         {
1692           try
1693           {
1694             if (close)
1695             {
1696               frames[i].setClosed(true);
1697             }
1698             else
1699             {
1700               frames[i].setIcon(minimize);
1701               if (!minimize)
1702               {
1703                 frames[i].toFront();
1704               }
1705             }
1706
1707           } catch (java.beans.PropertyVetoException ex)
1708           {
1709           }
1710         }
1711       }
1712     }
1713   }
1714
1715   /**
1716    * DOCUMENT ME!
1717    *
1718    * @param e
1719    *          DOCUMENT ME!
1720    */
1721   @Override
1722   protected void preferences_actionPerformed(ActionEvent e)
1723   {
1724     Preferences.openPreferences();
1725   }
1726
1727   /**
1728    * Prompts the user to choose a file and then saves the Jalview state as a
1729    * Jalview project file
1730    */
1731   @Override
1732   public void saveState_actionPerformed()
1733   {
1734     saveState_actionPerformed(false);
1735   }
1736
1737   public void saveState_actionPerformed(boolean saveAs)
1738   {
1739     java.io.File projectFile = getProjectFile();
1740     // autoSave indicates we already have a file and don't need to ask
1741     boolean autoSave = projectFile != null && !saveAs
1742             && BackupFiles.getEnabled();
1743
1744     // System.out.println("autoSave="+autoSave+", projectFile='"+projectFile+"',
1745     // saveAs="+saveAs+", Backups
1746     // "+(BackupFiles.getEnabled()?"enabled":"disabled"));
1747
1748     boolean approveSave = false;
1749     if (!autoSave)
1750     {
1751       JalviewFileChooser chooser = new JalviewFileChooser("jvp",
1752               "Jalview Project");
1753
1754       chooser.setFileView(new JalviewFileView());
1755       chooser.setDialogTitle(MessageManager.getString("label.save_state"));
1756
1757       int value = chooser.showSaveDialog(this);
1758
1759       if (value == JalviewFileChooser.APPROVE_OPTION)
1760       {
1761         projectFile = chooser.getSelectedFile();
1762         setProjectFile(projectFile);
1763         approveSave = true;
1764       }
1765     }
1766
1767     if (approveSave || autoSave)
1768     {
1769       final Desktop me = this;
1770       final java.io.File chosenFile = projectFile;
1771       new Thread(new Runnable()
1772       {
1773         @Override
1774         public void run()
1775         {
1776           // TODO: refactor to Jalview desktop session controller action.
1777           setProgressBar(MessageManager.formatMessage(
1778                   "label.saving_jalview_project", new Object[]
1779                   { chosenFile.getName() }), chosenFile.hashCode());
1780           Cache.setProperty("LAST_DIRECTORY", chosenFile.getParent());
1781           // TODO catch and handle errors for savestate
1782           // TODO prevent user from messing with the Desktop whilst we're saving
1783           try
1784           {
1785             boolean doBackup = BackupFiles.getEnabled();
1786             BackupFiles backupfiles = doBackup ? new BackupFiles(chosenFile)
1787                     : null;
1788
1789             new Jalview2XML().saveState(
1790                     doBackup ? backupfiles.getTempFile() : chosenFile);
1791
1792             if (doBackup)
1793             {
1794               backupfiles.setWriteSuccess(true);
1795               backupfiles.rollBackupsAndRenameTempFile();
1796             }
1797           } catch (OutOfMemoryError oom)
1798           {
1799             new OOMWarning("Whilst saving current state to "
1800                     + chosenFile.getName(), oom);
1801           } catch (Exception ex)
1802           {
1803             jalview.bin.Console.error("Problems whilst trying to save to "
1804                     + chosenFile.getName(), ex);
1805             JvOptionPane.showMessageDialog(me,
1806                     MessageManager.formatMessage(
1807                             "label.error_whilst_saving_current_state_to",
1808                             new Object[]
1809                             { chosenFile.getName() }),
1810                     MessageManager.getString("label.couldnt_save_project"),
1811                     JvOptionPane.WARNING_MESSAGE);
1812           }
1813           setProgressBar(null, chosenFile.hashCode());
1814         }
1815       }).start();
1816     }
1817   }
1818
1819   @Override
1820   public void saveAsState_actionPerformed(ActionEvent e)
1821   {
1822     saveState_actionPerformed(true);
1823   }
1824
1825   private void setProjectFile(File choice)
1826   {
1827     this.projectFile = choice;
1828   }
1829
1830   public File getProjectFile()
1831   {
1832     return this.projectFile;
1833   }
1834
1835   /**
1836    * Shows a file chooser dialog and tries to read in the selected file as a
1837    * Jalview project
1838    */
1839   @Override
1840   public void loadState_actionPerformed()
1841   {
1842     final String[] suffix = new String[] { "jvp", "jar" };
1843     final String[] desc = new String[] { "Jalview Project",
1844         "Jalview Project (old)" };
1845     JalviewFileChooser chooser = new JalviewFileChooser(
1846             Cache.getProperty("LAST_DIRECTORY"), suffix, desc,
1847             "Jalview Project", true, BackupFiles.getEnabled()); // last two
1848                                                                 // booleans:
1849                                                                 // allFiles,
1850     // allowBackupFiles
1851     chooser.setFileView(new JalviewFileView());
1852     chooser.setDialogTitle(MessageManager.getString("label.restore_state"));
1853     chooser.setResponseHandler(0, new Runnable()
1854     {
1855       @Override
1856       public void run()
1857       {
1858         File selectedFile = chooser.getSelectedFile();
1859         setProjectFile(selectedFile);
1860         String choice = selectedFile.getAbsolutePath();
1861         Cache.setProperty("LAST_DIRECTORY", selectedFile.getParent());
1862         new Thread(new Runnable()
1863         {
1864           @Override
1865           public void run()
1866           {
1867             try
1868             {
1869               new Jalview2XML().loadJalviewAlign(selectedFile);
1870             } catch (OutOfMemoryError oom)
1871             {
1872               new OOMWarning("Whilst loading project from " + choice, oom);
1873             } catch (Exception ex)
1874             {
1875               jalview.bin.Console.error(
1876                       "Problems whilst loading project from " + choice, ex);
1877               JvOptionPane.showMessageDialog(Desktop.desktop,
1878                       MessageManager.formatMessage(
1879                               "label.error_whilst_loading_project_from",
1880                               new Object[]
1881                               { choice }),
1882                       MessageManager
1883                               .getString("label.couldnt_load_project"),
1884                       JvOptionPane.WARNING_MESSAGE);
1885             }
1886           }
1887         }, "Project Loader").start();
1888       }
1889     });
1890
1891     chooser.showOpenDialog(this);
1892   }
1893
1894   @Override
1895   public void inputSequence_actionPerformed(ActionEvent e)
1896   {
1897     new SequenceFetcher(this);
1898   }
1899
1900   JPanel progressPanel;
1901
1902   ArrayList<JPanel> fileLoadingPanels = new ArrayList<>();
1903
1904   public void startLoading(final Object fileName)
1905   {
1906     if (fileLoadingCount == 0)
1907     {
1908       fileLoadingPanels.add(addProgressPanel(MessageManager
1909               .formatMessage("label.loading_file", new Object[]
1910               { fileName })));
1911     }
1912     fileLoadingCount++;
1913   }
1914
1915   private JPanel addProgressPanel(String string)
1916   {
1917     if (progressPanel == null)
1918     {
1919       progressPanel = new JPanel(new GridLayout(1, 1));
1920       totalProgressCount = 0;
1921       instance.getContentPane().add(progressPanel, BorderLayout.SOUTH);
1922     }
1923     JPanel thisprogress = new JPanel(new BorderLayout(10, 5));
1924     JProgressBar progressBar = new JProgressBar();
1925     progressBar.setIndeterminate(true);
1926
1927     thisprogress.add(new JLabel(string), BorderLayout.WEST);
1928
1929     thisprogress.add(progressBar, BorderLayout.CENTER);
1930     progressPanel.add(thisprogress);
1931     ((GridLayout) progressPanel.getLayout()).setRows(
1932             ((GridLayout) progressPanel.getLayout()).getRows() + 1);
1933     ++totalProgressCount;
1934     instance.validate();
1935     return thisprogress;
1936   }
1937
1938   int totalProgressCount = 0;
1939
1940   private void removeProgressPanel(JPanel progbar)
1941   {
1942     if (progressPanel != null)
1943     {
1944       synchronized (progressPanel)
1945       {
1946         progressPanel.remove(progbar);
1947         GridLayout gl = (GridLayout) progressPanel.getLayout();
1948         gl.setRows(gl.getRows() - 1);
1949         if (--totalProgressCount < 1)
1950         {
1951           this.getContentPane().remove(progressPanel);
1952           progressPanel = null;
1953         }
1954       }
1955     }
1956     validate();
1957   }
1958
1959   public void stopLoading()
1960   {
1961     fileLoadingCount--;
1962     if (fileLoadingCount < 1)
1963     {
1964       while (fileLoadingPanels.size() > 0)
1965       {
1966         removeProgressPanel(fileLoadingPanels.remove(0));
1967       }
1968       fileLoadingPanels.clear();
1969       fileLoadingCount = 0;
1970     }
1971     validate();
1972   }
1973
1974   public static int getViewCount(String alignmentId)
1975   {
1976     AlignmentViewport[] aps = getViewports(alignmentId);
1977     return (aps == null) ? 0 : aps.length;
1978   }
1979
1980   /**
1981    *
1982    * @param alignmentId
1983    *          - if null, all sets are returned
1984    * @return all AlignmentPanels concerning the alignmentId sequence set
1985    */
1986   public static AlignmentPanel[] getAlignmentPanels(String alignmentId)
1987   {
1988     if (Desktop.desktop == null)
1989     {
1990       // no frames created and in headless mode
1991       // TODO: verify that frames are recoverable when in headless mode
1992       return null;
1993     }
1994     List<AlignmentPanel> aps = new ArrayList<>();
1995     AlignFrame[] frames = getAlignFrames();
1996     if (frames == null)
1997     {
1998       return null;
1999     }
2000     for (AlignFrame af : frames)
2001     {
2002       for (AlignmentPanel ap : af.alignPanels)
2003       {
2004         if (alignmentId == null
2005                 || alignmentId.equals(ap.av.getSequenceSetId()))
2006         {
2007           aps.add(ap);
2008         }
2009       }
2010     }
2011     if (aps.size() == 0)
2012     {
2013       return null;
2014     }
2015     AlignmentPanel[] vap = aps.toArray(new AlignmentPanel[aps.size()]);
2016     return vap;
2017   }
2018
2019   /**
2020    * get all the viewports on an alignment.
2021    *
2022    * @param sequenceSetId
2023    *          unique alignment id (may be null - all viewports returned in that
2024    *          case)
2025    * @return all viewports on the alignment bound to sequenceSetId
2026    */
2027   public static AlignmentViewport[] getViewports(String sequenceSetId)
2028   {
2029     List<AlignmentViewport> viewp = new ArrayList<>();
2030     if (desktop != null)
2031     {
2032       AlignFrame[] frames = Desktop.getAlignFrames();
2033
2034       for (AlignFrame afr : frames)
2035       {
2036         if (sequenceSetId == null || afr.getViewport().getSequenceSetId()
2037                 .equals(sequenceSetId))
2038         {
2039           if (afr.alignPanels != null)
2040           {
2041             for (AlignmentPanel ap : afr.alignPanels)
2042             {
2043               if (sequenceSetId == null
2044                       || sequenceSetId.equals(ap.av.getSequenceSetId()))
2045               {
2046                 viewp.add(ap.av);
2047               }
2048             }
2049           }
2050           else
2051           {
2052             viewp.add(afr.getViewport());
2053           }
2054         }
2055       }
2056       if (viewp.size() > 0)
2057       {
2058         return viewp.toArray(new AlignmentViewport[viewp.size()]);
2059       }
2060     }
2061     return null;
2062   }
2063
2064   /**
2065    * Explode the views in the given frame into separate AlignFrame
2066    *
2067    * @param af
2068    */
2069   public static void explodeViews(AlignFrame af)
2070   {
2071     int size = af.alignPanels.size();
2072     if (size < 2)
2073     {
2074       return;
2075     }
2076
2077     // FIXME: ideally should use UI interface API
2078     FeatureSettings viewFeatureSettings = (af.featureSettings != null
2079             && af.featureSettings.isOpen()) ? af.featureSettings : null;
2080     Rectangle fsBounds = af.getFeatureSettingsGeometry();
2081     for (int i = 0; i < size; i++)
2082     {
2083       AlignmentPanel ap = af.alignPanels.get(i);
2084
2085       AlignFrame newaf = new AlignFrame(ap);
2086
2087       // transfer reference for existing feature settings to new alignFrame
2088       if (ap == af.alignPanel)
2089       {
2090         if (viewFeatureSettings != null && viewFeatureSettings.fr.ap == ap)
2091         {
2092           newaf.featureSettings = viewFeatureSettings;
2093         }
2094         newaf.setFeatureSettingsGeometry(fsBounds);
2095       }
2096
2097       /*
2098        * Restore the view's last exploded frame geometry if known. Multiple views from
2099        * one exploded frame share and restore the same (frame) position and size.
2100        */
2101       Rectangle geometry = ap.av.getExplodedGeometry();
2102       if (geometry != null)
2103       {
2104         newaf.setBounds(geometry);
2105       }
2106
2107       ap.av.setGatherViewsHere(false);
2108
2109       addInternalFrame(newaf, af.getTitle(), AlignFrame.DEFAULT_WIDTH,
2110               AlignFrame.DEFAULT_HEIGHT);
2111       // and materialise a new feature settings dialog instance for the new
2112       // alignframe
2113       // (closes the old as if 'OK' was pressed)
2114       if (ap == af.alignPanel && newaf.featureSettings != null
2115               && newaf.featureSettings.isOpen()
2116               && af.alignPanel.getAlignViewport().isShowSequenceFeatures())
2117       {
2118         newaf.showFeatureSettingsUI();
2119       }
2120     }
2121
2122     af.featureSettings = null;
2123     af.alignPanels.clear();
2124     af.closeMenuItem_actionPerformed(true);
2125
2126   }
2127
2128   /**
2129    * Gather expanded views (separate AlignFrame's) with the same sequence set
2130    * identifier back in to this frame as additional views, and close the
2131    * expanded views. Note the expanded frames may themselves have multiple
2132    * views. We take the lot.
2133    *
2134    * @param source
2135    */
2136   public void gatherViews(AlignFrame source)
2137   {
2138     source.viewport.setGatherViewsHere(true);
2139     source.viewport.setExplodedGeometry(source.getBounds());
2140     JInternalFrame[] frames = desktop.getAllFrames();
2141     String viewId = source.viewport.getSequenceSetId();
2142     for (int t = 0; t < frames.length; t++)
2143     {
2144       if (frames[t] instanceof AlignFrame && frames[t] != source)
2145       {
2146         AlignFrame af = (AlignFrame) frames[t];
2147         boolean gatherThis = false;
2148         for (int a = 0; a < af.alignPanels.size(); a++)
2149         {
2150           AlignmentPanel ap = af.alignPanels.get(a);
2151           if (viewId.equals(ap.av.getSequenceSetId()))
2152           {
2153             gatherThis = true;
2154             ap.av.setGatherViewsHere(false);
2155             ap.av.setExplodedGeometry(af.getBounds());
2156             source.addAlignmentPanel(ap, false);
2157           }
2158         }
2159
2160         if (gatherThis)
2161         {
2162           if (af.featureSettings != null && af.featureSettings.isOpen())
2163           {
2164             if (source.featureSettings == null)
2165             {
2166               // preserve the feature settings geometry for this frame
2167               source.featureSettings = af.featureSettings;
2168               source.setFeatureSettingsGeometry(
2169                       af.getFeatureSettingsGeometry());
2170             }
2171             else
2172             {
2173               // close it and forget
2174               af.featureSettings.close();
2175             }
2176           }
2177           af.alignPanels.clear();
2178           af.closeMenuItem_actionPerformed(true);
2179         }
2180       }
2181     }
2182
2183     // refresh the feature setting UI for the source frame if it exists
2184     if (source.featureSettings != null && source.featureSettings.isOpen())
2185     {
2186       source.showFeatureSettingsUI();
2187     }
2188
2189   }
2190
2191   public JInternalFrame[] getAllFrames()
2192   {
2193     return desktop.getAllFrames();
2194   }
2195
2196   /**
2197    * Checks the given url to see if it gives a response indicating that the user
2198    * should be informed of a new questionnaire.
2199    *
2200    * @param url
2201    */
2202   public void checkForQuestionnaire(String url)
2203   {
2204     UserQuestionnaireCheck jvq = new UserQuestionnaireCheck(url);
2205     // javax.swing.SwingUtilities.invokeLater(jvq);
2206     new Thread(jvq).start();
2207   }
2208
2209   public void checkURLLinks()
2210   {
2211     // Thread off the URL link checker
2212     addDialogThread(new Runnable()
2213     {
2214       @Override
2215       public void run()
2216       {
2217         if (Cache.getDefault("CHECKURLLINKS", true))
2218         {
2219           // check what the actual links are - if it's just the default don't
2220           // bother with the warning
2221           List<String> links = Preferences.sequenceUrlLinks
2222                   .getLinksForMenu();
2223
2224           // only need to check links if there is one with a
2225           // SEQUENCE_ID which is not the default EMBL_EBI link
2226           ListIterator<String> li = links.listIterator();
2227           boolean check = false;
2228           List<JLabel> urls = new ArrayList<>();
2229           while (li.hasNext())
2230           {
2231             String link = li.next();
2232             if (link.contains(jalview.util.UrlConstants.SEQUENCE_ID)
2233                     && !UrlConstants.isDefaultString(link))
2234             {
2235               check = true;
2236               int barPos = link.indexOf("|");
2237               String urlMsg = barPos == -1 ? link
2238                       : link.substring(0, barPos) + ": "
2239                               + link.substring(barPos + 1);
2240               urls.add(new JLabel(urlMsg));
2241             }
2242           }
2243           if (!check)
2244           {
2245             return;
2246           }
2247
2248           // ask user to check in case URL links use old style tokens
2249           // ($SEQUENCE_ID$ for sequence id _or_ accession id)
2250           JPanel msgPanel = new JPanel();
2251           msgPanel.setLayout(new BoxLayout(msgPanel, BoxLayout.PAGE_AXIS));
2252           msgPanel.add(Box.createVerticalGlue());
2253           JLabel msg = new JLabel(MessageManager
2254                   .getString("label.SEQUENCE_ID_for_DB_ACCESSION1"));
2255           JLabel msg2 = new JLabel(MessageManager
2256                   .getString("label.SEQUENCE_ID_for_DB_ACCESSION2"));
2257           msgPanel.add(msg);
2258           for (JLabel url : urls)
2259           {
2260             msgPanel.add(url);
2261           }
2262           msgPanel.add(msg2);
2263
2264           final JCheckBox jcb = new JCheckBox(
2265                   MessageManager.getString("label.do_not_display_again"));
2266           jcb.addActionListener(new ActionListener()
2267           {
2268             @Override
2269             public void actionPerformed(ActionEvent e)
2270             {
2271               // update Cache settings for "don't show this again"
2272               boolean showWarningAgain = !jcb.isSelected();
2273               Cache.setProperty("CHECKURLLINKS",
2274                       Boolean.valueOf(showWarningAgain).toString());
2275             }
2276           });
2277           msgPanel.add(jcb);
2278
2279           JvOptionPane.showMessageDialog(Desktop.desktop, msgPanel,
2280                   MessageManager
2281                           .getString("label.SEQUENCE_ID_no_longer_used"),
2282                   JvOptionPane.WARNING_MESSAGE);
2283         }
2284       }
2285     });
2286   }
2287
2288   /**
2289    * Proxy class for JDesktopPane which optionally displays the current memory
2290    * usage and highlights the desktop area with a red bar if free memory runs
2291    * low.
2292    *
2293    * @author AMW
2294    */
2295   public class MyDesktopPane extends JDesktopPane implements Runnable
2296   {
2297     private static final float ONE_MB = 1048576f;
2298
2299     boolean showMemoryUsage = false;
2300
2301     Runtime runtime;
2302
2303     java.text.NumberFormat df;
2304
2305     float maxMemory, allocatedMemory, freeMemory, totalFreeMemory,
2306             percentUsage;
2307
2308     public MyDesktopPane(boolean showMemoryUsage)
2309     {
2310       showMemoryUsage(showMemoryUsage);
2311     }
2312
2313     public void showMemoryUsage(boolean showMemory)
2314     {
2315       this.showMemoryUsage = showMemory;
2316       if (showMemory)
2317       {
2318         Thread worker = new Thread(this);
2319         worker.start();
2320       }
2321       repaint();
2322     }
2323
2324     public boolean isShowMemoryUsage()
2325     {
2326       return showMemoryUsage;
2327     }
2328
2329     @Override
2330     public void run()
2331     {
2332       df = java.text.NumberFormat.getNumberInstance();
2333       df.setMaximumFractionDigits(2);
2334       runtime = Runtime.getRuntime();
2335
2336       while (showMemoryUsage)
2337       {
2338         try
2339         {
2340           maxMemory = runtime.maxMemory() / ONE_MB;
2341           allocatedMemory = runtime.totalMemory() / ONE_MB;
2342           freeMemory = runtime.freeMemory() / ONE_MB;
2343           totalFreeMemory = freeMemory + (maxMemory - allocatedMemory);
2344
2345           percentUsage = (totalFreeMemory / maxMemory) * 100;
2346
2347           // if (percentUsage < 20)
2348           {
2349             // border1 = BorderFactory.createMatteBorder(12, 12, 12, 12,
2350             // Color.red);
2351             // instance.set.setBorder(border1);
2352           }
2353           repaint();
2354           // sleep after showing usage
2355           Thread.sleep(3000);
2356         } catch (Exception ex)
2357         {
2358           ex.printStackTrace();
2359         }
2360       }
2361     }
2362
2363     @Override
2364     public void paintComponent(Graphics g)
2365     {
2366       if (showMemoryUsage && g != null && df != null)
2367       {
2368         if (percentUsage < 20)
2369         {
2370           g.setColor(Color.red);
2371         }
2372         FontMetrics fm = g.getFontMetrics();
2373         if (fm != null)
2374         {
2375           g.drawString(MessageManager.formatMessage("label.memory_stats",
2376                   new Object[]
2377                   { df.format(totalFreeMemory), df.format(maxMemory),
2378                       df.format(percentUsage) }),
2379                   10, getHeight() - fm.getHeight());
2380         }
2381       }
2382
2383       // output debug scale message. Important for jalview.bin.HiDPISettingTest2
2384       Desktop.debugScaleMessage(Desktop.getDesktop().getGraphics());
2385     }
2386   }
2387
2388   /**
2389    * Accessor method to quickly get all the AlignmentFrames loaded.
2390    *
2391    * @return an array of AlignFrame, or null if none found
2392    */
2393   public static AlignFrame[] getAlignFrames()
2394   {
2395     if (Jalview.isHeadlessMode())
2396     {
2397       // Desktop.desktop is null in headless mode
2398       return new AlignFrame[] { Jalview.currentAlignFrame };
2399     }
2400
2401     JInternalFrame[] frames = Desktop.desktop.getAllFrames();
2402
2403     if (frames == null)
2404     {
2405       return null;
2406     }
2407     List<AlignFrame> avp = new ArrayList<>();
2408     // REVERSE ORDER
2409     for (int i = frames.length - 1; i > -1; i--)
2410     {
2411       if (frames[i] instanceof AlignFrame)
2412       {
2413         avp.add((AlignFrame) frames[i]);
2414       }
2415       else if (frames[i] instanceof SplitFrame)
2416       {
2417         /*
2418          * Also check for a split frame containing an AlignFrame
2419          */
2420         GSplitFrame sf = (GSplitFrame) frames[i];
2421         if (sf.getTopFrame() instanceof AlignFrame)
2422         {
2423           avp.add((AlignFrame) sf.getTopFrame());
2424         }
2425         if (sf.getBottomFrame() instanceof AlignFrame)
2426         {
2427           avp.add((AlignFrame) sf.getBottomFrame());
2428         }
2429       }
2430     }
2431     if (avp.size() == 0)
2432     {
2433       return null;
2434     }
2435     AlignFrame afs[] = avp.toArray(new AlignFrame[avp.size()]);
2436     return afs;
2437   }
2438
2439   /**
2440    * Returns an array of any AppJmol frames in the Desktop (or null if none).
2441    *
2442    * @return
2443    */
2444   public GStructureViewer[] getJmols()
2445   {
2446     JInternalFrame[] frames = Desktop.desktop.getAllFrames();
2447
2448     if (frames == null)
2449     {
2450       return null;
2451     }
2452     List<GStructureViewer> avp = new ArrayList<>();
2453     // REVERSE ORDER
2454     for (int i = frames.length - 1; i > -1; i--)
2455     {
2456       if (frames[i] instanceof AppJmol)
2457       {
2458         GStructureViewer af = (GStructureViewer) frames[i];
2459         avp.add(af);
2460       }
2461     }
2462     if (avp.size() == 0)
2463     {
2464       return null;
2465     }
2466     GStructureViewer afs[] = avp.toArray(new GStructureViewer[avp.size()]);
2467     return afs;
2468   }
2469
2470   /**
2471    * Add Groovy Support to Jalview
2472    */
2473   @Override
2474   public void groovyShell_actionPerformed()
2475   {
2476     try
2477     {
2478       openGroovyConsole();
2479     } catch (Exception ex)
2480     {
2481       jalview.bin.Console.error("Groovy Shell Creation failed.", ex);
2482       JvOptionPane.showInternalMessageDialog(Desktop.desktop,
2483
2484               MessageManager.getString("label.couldnt_create_groovy_shell"),
2485               MessageManager.getString("label.groovy_support_failed"),
2486               JvOptionPane.ERROR_MESSAGE);
2487     }
2488   }
2489
2490   /**
2491    * Open the Groovy console
2492    */
2493   void openGroovyConsole()
2494   {
2495     if (groovyConsole == null)
2496     {
2497       groovyConsole = new groovy.ui.Console();
2498       groovyConsole.setVariable("Jalview", this);
2499       groovyConsole.run();
2500
2501       /*
2502        * We allow only one console at a time, so that AlignFrame menu option
2503        * 'Calculate | Run Groovy script' is unambiguous. Disable 'Groovy Console', and
2504        * enable 'Run script', when the console is opened, and the reverse when it is
2505        * closed
2506        */
2507       Window window = (Window) groovyConsole.getFrame();
2508       window.addWindowListener(new WindowAdapter()
2509       {
2510         @Override
2511         public void windowClosed(WindowEvent e)
2512         {
2513           /*
2514            * rebind CMD-Q from Groovy Console to Jalview Quit
2515            */
2516           addQuitHandler();
2517           enableExecuteGroovy(false);
2518         }
2519       });
2520     }
2521
2522     /*
2523      * show Groovy console window (after close and reopen)
2524      */
2525     ((Window) groovyConsole.getFrame()).setVisible(true);
2526
2527     /*
2528      * if we got this far, enable 'Run Groovy' in AlignFrame menus and disable
2529      * opening a second console
2530      */
2531     enableExecuteGroovy(true);
2532   }
2533
2534   /**
2535    * Bind Ctrl/Cmd-Q to Quit - for reset as Groovy Console takes over this
2536    * binding when opened
2537    */
2538   protected void addQuitHandler()
2539   {
2540     getRootPane()
2541             .getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(
2542                     KeyStroke
2543                             .getKeyStroke(KeyEvent.VK_Q,
2544                                     jalview.util.ShortcutKeyMaskExWrapper
2545                                             .getMenuShortcutKeyMaskEx()),
2546                     "Quit");
2547     getRootPane().getActionMap().put("Quit", new AbstractAction()
2548     {
2549       @Override
2550       public void actionPerformed(ActionEvent e)
2551       {
2552         quit();
2553       }
2554     });
2555   }
2556
2557   /**
2558    * Enable or disable 'Run Groovy script' in AlignFrame calculate menus
2559    *
2560    * @param enabled
2561    *          true if Groovy console is open
2562    */
2563   public void enableExecuteGroovy(boolean enabled)
2564   {
2565     /*
2566      * disable opening a second Groovy console (or re-enable when the console is
2567      * closed)
2568      */
2569     groovyShell.setEnabled(!enabled);
2570
2571     AlignFrame[] alignFrames = getAlignFrames();
2572     if (alignFrames != null)
2573     {
2574       for (AlignFrame af : alignFrames)
2575       {
2576         af.setGroovyEnabled(enabled);
2577       }
2578     }
2579   }
2580
2581   /**
2582    * Progress bars managed by the IProgressIndicator method.
2583    */
2584   private Hashtable<Long, JPanel> progressBars;
2585
2586   private Hashtable<Long, IProgressIndicatorHandler> progressBarHandlers;
2587
2588   /*
2589    * (non-Javadoc)
2590    *
2591    * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
2592    */
2593   @Override
2594   public void setProgressBar(String message, long id)
2595   {
2596     if (progressBars == null)
2597     {
2598       progressBars = new Hashtable<>();
2599       progressBarHandlers = new Hashtable<>();
2600     }
2601
2602     if (progressBars.get(Long.valueOf(id)) != null)
2603     {
2604       JPanel panel = progressBars.remove(Long.valueOf(id));
2605       if (progressBarHandlers.contains(Long.valueOf(id)))
2606       {
2607         progressBarHandlers.remove(Long.valueOf(id));
2608       }
2609       removeProgressPanel(panel);
2610     }
2611     else
2612     {
2613       progressBars.put(Long.valueOf(id), addProgressPanel(message));
2614     }
2615   }
2616
2617   /*
2618    * (non-Javadoc)
2619    *
2620    * @see jalview.gui.IProgressIndicator#registerHandler(long,
2621    * jalview.gui.IProgressIndicatorHandler)
2622    */
2623   @Override
2624   public void registerHandler(final long id,
2625           final IProgressIndicatorHandler handler)
2626   {
2627     if (progressBarHandlers == null
2628             || !progressBars.containsKey(Long.valueOf(id)))
2629     {
2630       throw new Error(MessageManager.getString(
2631               "error.call_setprogressbar_before_registering_handler"));
2632     }
2633     progressBarHandlers.put(Long.valueOf(id), handler);
2634     final JPanel progressPanel = progressBars.get(Long.valueOf(id));
2635     if (handler.canCancel())
2636     {
2637       JButton cancel = new JButton(
2638               MessageManager.getString("action.cancel"));
2639       final IProgressIndicator us = this;
2640       cancel.addActionListener(new ActionListener()
2641       {
2642
2643         @Override
2644         public void actionPerformed(ActionEvent e)
2645         {
2646           handler.cancelActivity(id);
2647           us.setProgressBar(MessageManager
2648                   .formatMessage("label.cancelled_params", new Object[]
2649                   { ((JLabel) progressPanel.getComponent(0)).getText() }),
2650                   id);
2651         }
2652       });
2653       progressPanel.add(cancel, BorderLayout.EAST);
2654     }
2655   }
2656
2657   /**
2658    *
2659    * @return true if any progress bars are still active
2660    */
2661   @Override
2662   public boolean operationInProgress()
2663   {
2664     if (progressBars != null && progressBars.size() > 0)
2665     {
2666       return true;
2667     }
2668     return false;
2669   }
2670
2671   /**
2672    * This will return the first AlignFrame holding the given viewport instance.
2673    * It will break if there are more than one AlignFrames viewing a particular
2674    * av.
2675    *
2676    * @param viewport
2677    * @return alignFrame for viewport
2678    */
2679   public static AlignFrame getAlignFrameFor(AlignViewportI viewport)
2680   {
2681     if (desktop != null)
2682     {
2683       AlignmentPanel[] aps = getAlignmentPanels(
2684               viewport.getSequenceSetId());
2685       for (int panel = 0; aps != null && panel < aps.length; panel++)
2686       {
2687         if (aps[panel] != null && aps[panel].av == viewport)
2688         {
2689           return aps[panel].alignFrame;
2690         }
2691       }
2692     }
2693     return null;
2694   }
2695
2696   public VamsasApplication getVamsasApplication()
2697   {
2698     // TODO: JAL-3311 remove remaining code from Jalview relating to VAMSAS
2699     return null;
2700
2701   }
2702
2703   /**
2704    * flag set if jalview GUI is being operated programmatically
2705    */
2706   private boolean inBatchMode = false;
2707
2708   /**
2709    * check if jalview GUI is being operated programmatically
2710    *
2711    * @return inBatchMode
2712    */
2713   public boolean isInBatchMode()
2714   {
2715     return inBatchMode;
2716   }
2717
2718   /**
2719    * set flag if jalview GUI is being operated programmatically
2720    *
2721    * @param inBatchMode
2722    */
2723   public void setInBatchMode(boolean inBatchMode)
2724   {
2725     this.inBatchMode = inBatchMode;
2726   }
2727
2728   /**
2729    * start service discovery and wait till it is done
2730    */
2731   public void startServiceDiscovery()
2732   {
2733     startServiceDiscovery(false);
2734   }
2735
2736   /**
2737    * start service discovery threads - blocking or non-blocking
2738    *
2739    * @param blocking
2740    */
2741   public void startServiceDiscovery(boolean blocking)
2742   {
2743     startServiceDiscovery(blocking, false);
2744   }
2745
2746   /**
2747    * start service discovery threads
2748    *
2749    * @param blocking
2750    *          - false means call returns immediately
2751    * @param ignore_SHOW_JWS2_SERVICES_preference
2752    *          - when true JABA services are discovered regardless of user's JWS2
2753    *          discovery preference setting
2754    */
2755   public void startServiceDiscovery(boolean blocking,
2756           boolean ignore_SHOW_JWS2_SERVICES_preference)
2757   {
2758     boolean alive = true;
2759     Thread t0 = null, t1 = null, t2 = null;
2760     // JAL-940 - JALVIEW 1 services are now being EOLed as of JABA 2.1 release
2761     if (true)
2762     {
2763       // todo: changesupport handlers need to be transferred
2764       if (discoverer == null)
2765       {
2766         discoverer = new jalview.ws.jws1.Discoverer();
2767         // register PCS handler for desktop.
2768         discoverer.addPropertyChangeListener(changeSupport);
2769       }
2770       // JAL-940 - disabled JWS1 service configuration - always start discoverer
2771       // until we phase out completely
2772       (t0 = new Thread(discoverer)).start();
2773     }
2774
2775     if (ignore_SHOW_JWS2_SERVICES_preference
2776             || Cache.getDefault("SHOW_JWS2_SERVICES", true))
2777     {
2778       t2 = jalview.ws.jws2.Jws2Discoverer.getDiscoverer()
2779               .startDiscoverer(changeSupport);
2780     }
2781     Thread t3 = null;
2782     {
2783       // TODO: do rest service discovery
2784     }
2785     if (blocking)
2786     {
2787       while (alive)
2788       {
2789         try
2790         {
2791           Thread.sleep(15);
2792         } catch (Exception e)
2793         {
2794         }
2795         alive = (t1 != null && t1.isAlive()) || (t2 != null && t2.isAlive())
2796                 || (t3 != null && t3.isAlive())
2797                 || (t0 != null && t0.isAlive());
2798       }
2799     }
2800   }
2801
2802   /**
2803    * called to check if the service discovery process completed successfully.
2804    *
2805    * @param evt
2806    */
2807   protected void JalviewServicesChanged(PropertyChangeEvent evt)
2808   {
2809     if (evt.getNewValue() == null || evt.getNewValue() instanceof Vector)
2810     {
2811       final String ermsg = jalview.ws.jws2.Jws2Discoverer.getDiscoverer()
2812               .getErrorMessages();
2813       if (ermsg != null)
2814       {
2815         if (Cache.getDefault("SHOW_WSDISCOVERY_ERRORS", true))
2816         {
2817           if (serviceChangedDialog == null)
2818           {
2819             // only run if we aren't already displaying one of these.
2820             addDialogThread(serviceChangedDialog = new Runnable()
2821             {
2822               @Override
2823               public void run()
2824               {
2825
2826                 /*
2827                  * JalviewDialog jd =new JalviewDialog() {
2828                  *
2829                  * @Override protected void cancelPressed() { // TODO Auto-generated method stub
2830                  *
2831                  * }@Override protected void okPressed() { // TODO Auto-generated method stub
2832                  *
2833                  * }@Override protected void raiseClosed() { // TODO Auto-generated method stub
2834                  *
2835                  * } }; jd.initDialogFrame(new JLabel("<html><table width=\"450\"><tr><td>" +
2836                  * ermsg +
2837                  * "<br/>It may be that you have invalid JABA URLs in your web service preferences,"
2838                  * + " or mis-configured HTTP proxy settings.<br/>" +
2839                  * "Check the <em>Connections</em> and <em>Web services</em> tab of the" +
2840                  * " Tools->Preferences dialog box to change them.</td></tr></table></html>" ),
2841                  * true, true, "Web Service Configuration Problem", 450, 400);
2842                  *
2843                  * jd.waitForInput();
2844                  */
2845                 JvOptionPane.showConfirmDialog(Desktop.desktop,
2846                         new JLabel("<html><table width=\"450\"><tr><td>"
2847                                 + ermsg + "</td></tr></table>"
2848                                 + "<p>It may be that you have invalid JABA URLs<br/>in your web service preferences,"
2849                                 + "<br>or as a command-line argument, or mis-configured HTTP proxy settings.</p>"
2850                                 + "<p>Check the <em>Connections</em> and <em>Web services</em> tab<br/>of the"
2851                                 + " Tools->Preferences dialog box to change them.</p></html>"),
2852                         "Web Service Configuration Problem",
2853                         JvOptionPane.DEFAULT_OPTION,
2854                         JvOptionPane.ERROR_MESSAGE);
2855                 serviceChangedDialog = null;
2856
2857               }
2858             });
2859           }
2860         }
2861         else
2862         {
2863           jalview.bin.Console.error(
2864                   "Errors reported by JABA discovery service. Check web services preferences.\n"
2865                           + ermsg);
2866         }
2867       }
2868     }
2869   }
2870
2871   private Runnable serviceChangedDialog = null;
2872
2873   /**
2874    * start a thread to open a URL in the configured browser. Pops up a warning
2875    * dialog to the user if there is an exception when calling out to the browser
2876    * to open the URL.
2877    *
2878    * @param url
2879    */
2880   public static void showUrl(final String url)
2881   {
2882     showUrl(url, Desktop.instance);
2883   }
2884
2885   /**
2886    * Like showUrl but allows progress handler to be specified
2887    *
2888    * @param url
2889    * @param progress
2890    *          (null) or object implementing IProgressIndicator
2891    */
2892   public static void showUrl(final String url,
2893           final IProgressIndicator progress)
2894   {
2895     new Thread(new Runnable()
2896     {
2897       @Override
2898       public void run()
2899       {
2900         try
2901         {
2902           if (progress != null)
2903           {
2904             progress.setProgressBar(MessageManager
2905                     .formatMessage("status.opening_params", new Object[]
2906                     { url }), this.hashCode());
2907           }
2908           jalview.util.BrowserLauncher.openURL(url);
2909         } catch (Exception ex)
2910         {
2911           JvOptionPane.showInternalMessageDialog(Desktop.desktop,
2912                   MessageManager
2913                           .getString("label.web_browser_not_found_unix"),
2914                   MessageManager.getString("label.web_browser_not_found"),
2915                   JvOptionPane.WARNING_MESSAGE);
2916
2917           ex.printStackTrace();
2918         }
2919         if (progress != null)
2920         {
2921           progress.setProgressBar(null, this.hashCode());
2922         }
2923       }
2924     }).start();
2925   }
2926
2927   public static WsParamSetManager wsparamManager = null;
2928
2929   public static ParamManager getUserParameterStore()
2930   {
2931     if (wsparamManager == null)
2932     {
2933       wsparamManager = new WsParamSetManager();
2934     }
2935     return wsparamManager;
2936   }
2937
2938   /**
2939    * static hyperlink handler proxy method for use by Jalview's internal windows
2940    *
2941    * @param e
2942    */
2943   public static void hyperlinkUpdate(HyperlinkEvent e)
2944   {
2945     if (e.getEventType() == EventType.ACTIVATED)
2946     {
2947       String url = null;
2948       try
2949       {
2950         url = e.getURL().toString();
2951         Desktop.showUrl(url);
2952       } catch (Exception x)
2953       {
2954         if (url != null)
2955         {
2956           jalview.bin.Console
2957                   .error("Couldn't handle string " + url + " as a URL.");
2958         }
2959         // ignore any exceptions due to dud links.
2960       }
2961
2962     }
2963   }
2964
2965   /**
2966    * single thread that handles display of dialogs to user.
2967    */
2968   ExecutorService dialogExecutor = Executors.newSingleThreadExecutor();
2969
2970   /**
2971    * flag indicating if dialogExecutor should try to acquire a permit
2972    */
2973   private volatile boolean dialogPause = true;
2974
2975   /**
2976    * pause the queue
2977    */
2978   private java.util.concurrent.Semaphore block = new Semaphore(0);
2979
2980   private static groovy.ui.Console groovyConsole;
2981
2982   /**
2983    * add another dialog thread to the queue
2984    *
2985    * @param prompter
2986    */
2987   public void addDialogThread(final Runnable prompter)
2988   {
2989     dialogExecutor.submit(new Runnable()
2990     {
2991       @Override
2992       public void run()
2993       {
2994         if (dialogPause)
2995         {
2996           try
2997           {
2998             block.acquire();
2999           } catch (InterruptedException x)
3000           {
3001           }
3002         }
3003         if (instance == null)
3004         {
3005           return;
3006         }
3007         try
3008         {
3009           SwingUtilities.invokeAndWait(prompter);
3010         } catch (Exception q)
3011         {
3012           jalview.bin.Console.warn("Unexpected Exception in dialog thread.",
3013                   q);
3014         }
3015       }
3016     });
3017   }
3018
3019   public void startDialogQueue()
3020   {
3021     // set the flag so we don't pause waiting for another permit and semaphore
3022     // the current task to begin
3023     dialogPause = false;
3024     block.release();
3025   }
3026
3027   /**
3028    * Outputs an image of the desktop to file in EPS format, after prompting the
3029    * user for choice of Text or Lineart character rendering (unless a preference
3030    * has been set). The file name is generated as
3031    *
3032    * <pre>
3033    * Jalview_snapshot_nnnnn.eps where nnnnn is the current timestamp in milliseconds
3034    * </pre>
3035    */
3036   @Override
3037   protected void snapShotWindow_actionPerformed(ActionEvent e)
3038   {
3039     // currently the menu option to do this is not shown
3040     invalidate();
3041
3042     int width = getWidth();
3043     int height = getHeight();
3044     File of = new File(
3045             "Jalview_snapshot_" + System.currentTimeMillis() + ".eps");
3046     ImageWriterI writer = new ImageWriterI()
3047     {
3048       @Override
3049       public void exportImage(Graphics g) throws Exception
3050       {
3051         paintAll(g);
3052         jalview.bin.Console.info("Successfully written snapshot to file "
3053                 + of.getAbsolutePath());
3054       }
3055     };
3056     String title = "View of desktop";
3057     ImageExporter exporter = new ImageExporter(writer, null, TYPE.EPS,
3058             title);
3059     exporter.doExport(of, this, width, height, title);
3060   }
3061
3062   /**
3063    * Explode the views in the given SplitFrame into separate SplitFrame windows.
3064    * This respects (remembers) any previous 'exploded geometry' i.e. the size
3065    * and location last time the view was expanded (if any). However it does not
3066    * remember the split pane divider location - this is set to match the
3067    * 'exploding' frame.
3068    *
3069    * @param sf
3070    */
3071   public void explodeViews(SplitFrame sf)
3072   {
3073     AlignFrame oldTopFrame = (AlignFrame) sf.getTopFrame();
3074     AlignFrame oldBottomFrame = (AlignFrame) sf.getBottomFrame();
3075     List<? extends AlignmentViewPanel> topPanels = oldTopFrame
3076             .getAlignPanels();
3077     List<? extends AlignmentViewPanel> bottomPanels = oldBottomFrame
3078             .getAlignPanels();
3079     int viewCount = topPanels.size();
3080     if (viewCount < 2)
3081     {
3082       return;
3083     }
3084
3085     /*
3086      * Processing in reverse order works, forwards order leaves the first panels not
3087      * visible. I don't know why!
3088      */
3089     for (int i = viewCount - 1; i >= 0; i--)
3090     {
3091       /*
3092        * Make new top and bottom frames. These take over the respective AlignmentPanel
3093        * objects, including their AlignmentViewports, so the cdna/protein
3094        * relationships between the viewports is carried over to the new split frames.
3095        *
3096        * explodedGeometry holds the (x, y) position of the previously exploded
3097        * SplitFrame, and the (width, height) of the AlignFrame component
3098        */
3099       AlignmentPanel topPanel = (AlignmentPanel) topPanels.get(i);
3100       AlignFrame newTopFrame = new AlignFrame(topPanel);
3101       newTopFrame.setSize(oldTopFrame.getSize());
3102       newTopFrame.setVisible(true);
3103       Rectangle geometry = ((AlignViewport) topPanel.getAlignViewport())
3104               .getExplodedGeometry();
3105       if (geometry != null)
3106       {
3107         newTopFrame.setSize(geometry.getSize());
3108       }
3109
3110       AlignmentPanel bottomPanel = (AlignmentPanel) bottomPanels.get(i);
3111       AlignFrame newBottomFrame = new AlignFrame(bottomPanel);
3112       newBottomFrame.setSize(oldBottomFrame.getSize());
3113       newBottomFrame.setVisible(true);
3114       geometry = ((AlignViewport) bottomPanel.getAlignViewport())
3115               .getExplodedGeometry();
3116       if (geometry != null)
3117       {
3118         newBottomFrame.setSize(geometry.getSize());
3119       }
3120
3121       topPanel.av.setGatherViewsHere(false);
3122       bottomPanel.av.setGatherViewsHere(false);
3123       JInternalFrame splitFrame = new SplitFrame(newTopFrame,
3124               newBottomFrame);
3125       if (geometry != null)
3126       {
3127         splitFrame.setLocation(geometry.getLocation());
3128       }
3129       Desktop.addInternalFrame(splitFrame, sf.getTitle(), -1, -1);
3130     }
3131
3132     /*
3133      * Clear references to the panels (now relocated in the new SplitFrames) before
3134      * closing the old SplitFrame.
3135      */
3136     topPanels.clear();
3137     bottomPanels.clear();
3138     sf.close();
3139   }
3140
3141   /**
3142    * Gather expanded split frames, sharing the same pairs of sequence set ids,
3143    * back into the given SplitFrame as additional views. Note that the gathered
3144    * frames may themselves have multiple views.
3145    *
3146    * @param source
3147    */
3148   public void gatherViews(GSplitFrame source)
3149   {
3150     /*
3151      * special handling of explodedGeometry for a view within a SplitFrame: - it
3152      * holds the (x, y) position of the enclosing SplitFrame, and the (width,
3153      * height) of the AlignFrame component
3154      */
3155     AlignFrame myTopFrame = (AlignFrame) source.getTopFrame();
3156     AlignFrame myBottomFrame = (AlignFrame) source.getBottomFrame();
3157     myTopFrame.viewport.setExplodedGeometry(new Rectangle(source.getX(),
3158             source.getY(), myTopFrame.getWidth(), myTopFrame.getHeight()));
3159     myBottomFrame.viewport
3160             .setExplodedGeometry(new Rectangle(source.getX(), source.getY(),
3161                     myBottomFrame.getWidth(), myBottomFrame.getHeight()));
3162     myTopFrame.viewport.setGatherViewsHere(true);
3163     myBottomFrame.viewport.setGatherViewsHere(true);
3164     String topViewId = myTopFrame.viewport.getSequenceSetId();
3165     String bottomViewId = myBottomFrame.viewport.getSequenceSetId();
3166
3167     JInternalFrame[] frames = desktop.getAllFrames();
3168     for (JInternalFrame frame : frames)
3169     {
3170       if (frame instanceof SplitFrame && frame != source)
3171       {
3172         SplitFrame sf = (SplitFrame) frame;
3173         AlignFrame topFrame = (AlignFrame) sf.getTopFrame();
3174         AlignFrame bottomFrame = (AlignFrame) sf.getBottomFrame();
3175         boolean gatherThis = false;
3176         for (int a = 0; a < topFrame.alignPanels.size(); a++)
3177         {
3178           AlignmentPanel topPanel = topFrame.alignPanels.get(a);
3179           AlignmentPanel bottomPanel = bottomFrame.alignPanels.get(a);
3180           if (topViewId.equals(topPanel.av.getSequenceSetId())
3181                   && bottomViewId.equals(bottomPanel.av.getSequenceSetId()))
3182           {
3183             gatherThis = true;
3184             topPanel.av.setGatherViewsHere(false);
3185             bottomPanel.av.setGatherViewsHere(false);
3186             topPanel.av.setExplodedGeometry(
3187                     new Rectangle(sf.getLocation(), topFrame.getSize()));
3188             bottomPanel.av.setExplodedGeometry(
3189                     new Rectangle(sf.getLocation(), bottomFrame.getSize()));
3190             myTopFrame.addAlignmentPanel(topPanel, false);
3191             myBottomFrame.addAlignmentPanel(bottomPanel, false);
3192           }
3193         }
3194
3195         if (gatherThis)
3196         {
3197           topFrame.getAlignPanels().clear();
3198           bottomFrame.getAlignPanels().clear();
3199           sf.close();
3200         }
3201       }
3202     }
3203
3204     /*
3205      * The dust settles...give focus to the tab we did this from.
3206      */
3207     myTopFrame.setDisplayedView(myTopFrame.alignPanel);
3208   }
3209
3210   public static groovy.ui.Console getGroovyConsole()
3211   {
3212     return groovyConsole;
3213   }
3214
3215   /**
3216    * handles the payload of a drag and drop event.
3217    *
3218    * TODO refactor to desktop utilities class
3219    *
3220    * @param files
3221    *          - Data source strings extracted from the drop event
3222    * @param protocols
3223    *          - protocol for each data source extracted from the drop event
3224    * @param evt
3225    *          - the drop event
3226    * @param t
3227    *          - the payload from the drop event
3228    * @throws Exception
3229    */
3230   public static void transferFromDropTarget(List<Object> files,
3231           List<DataSourceType> protocols, DropTargetDropEvent evt,
3232           Transferable t) throws Exception
3233   {
3234
3235     // BH 2018 changed List<String> to List<Object> to allow for File from
3236     // SwingJS
3237
3238     // DataFlavor[] flavors = t.getTransferDataFlavors();
3239     // for (int i = 0; i < flavors.length; i++) {
3240     // if (flavors[i].isFlavorJavaFileListType()) {
3241     // evt.acceptDrop(DnDConstants.ACTION_COPY_OR_MOVE);
3242     // List<File> list = (List<File>) t.getTransferData(flavors[i]);
3243     // for (int j = 0; j < list.size(); j++) {
3244     // File file = (File) list.get(j);
3245     // byte[] data = getDroppedFileBytes(file);
3246     // fileName.setText(file.getName() + " - " + data.length + " " +
3247     // evt.getLocation());
3248     // JTextArea target = (JTextArea) ((DropTarget)
3249     // evt.getSource()).getComponent();
3250     // target.setText(new String(data));
3251     // }
3252     // dtde.dropComplete(true);
3253     // return;
3254     // }
3255     //
3256
3257     DataFlavor uriListFlavor = new DataFlavor(
3258             "text/uri-list;class=java.lang.String"), urlFlavour = null;
3259     try
3260     {
3261       urlFlavour = new DataFlavor(
3262               "application/x-java-url; class=java.net.URL");
3263     } catch (ClassNotFoundException cfe)
3264     {
3265       jalview.bin.Console.debug("Couldn't instantiate the URL dataflavor.",
3266               cfe);
3267     }
3268
3269     if (urlFlavour != null && t.isDataFlavorSupported(urlFlavour))
3270     {
3271
3272       try
3273       {
3274         java.net.URL url = (URL) t.getTransferData(urlFlavour);
3275         // nb: java 8 osx bug https://bugs.openjdk.java.net/browse/JDK-8156099
3276         // means url may be null.
3277         if (url != null)
3278         {
3279           protocols.add(DataSourceType.URL);
3280           files.add(url.toString());
3281           jalview.bin.Console.debug("Drop handled as URL dataflavor "
3282                   + files.get(files.size() - 1));
3283           return;
3284         }
3285         else
3286         {
3287           if (Platform.isAMacAndNotJS())
3288           {
3289             System.err.println(
3290                     "Please ignore plist error - occurs due to problem with java 8 on OSX");
3291           }
3292         }
3293       } catch (Throwable ex)
3294       {
3295         jalview.bin.Console.debug("URL drop handler failed.", ex);
3296       }
3297     }
3298     if (t.isDataFlavorSupported(DataFlavor.javaFileListFlavor))
3299     {
3300       // Works on Windows and MacOSX
3301       jalview.bin.Console.debug("Drop handled as javaFileListFlavor");
3302       for (Object file : (List) t
3303               .getTransferData(DataFlavor.javaFileListFlavor))
3304       {
3305         files.add(file);
3306         protocols.add(DataSourceType.FILE);
3307       }
3308     }
3309     else
3310     {
3311       // Unix like behaviour
3312       boolean added = false;
3313       String data = null;
3314       if (t.isDataFlavorSupported(uriListFlavor))
3315       {
3316         jalview.bin.Console.debug("Drop handled as uriListFlavor");
3317         // This is used by Unix drag system
3318         data = (String) t.getTransferData(uriListFlavor);
3319       }
3320       if (data == null)
3321       {
3322         // fallback to text: workaround - on OSX where there's a JVM bug
3323         jalview.bin.Console
3324                 .debug("standard URIListFlavor failed. Trying text");
3325         // try text fallback
3326         DataFlavor textDf = new DataFlavor(
3327                 "text/plain;class=java.lang.String");
3328         if (t.isDataFlavorSupported(textDf))
3329         {
3330           data = (String) t.getTransferData(textDf);
3331         }
3332
3333         jalview.bin.Console.debug("Plain text drop content returned "
3334                 + (data == null ? "Null - failed" : data));
3335
3336       }
3337       if (data != null)
3338       {
3339         while (protocols.size() < files.size())
3340         {
3341           jalview.bin.Console.debug("Adding missing FILE protocol for "
3342                   + files.get(protocols.size()));
3343           protocols.add(DataSourceType.FILE);
3344         }
3345         for (java.util.StringTokenizer st = new java.util.StringTokenizer(
3346                 data, "\r\n"); st.hasMoreTokens();)
3347         {
3348           added = true;
3349           String s = st.nextToken();
3350           if (s.startsWith("#"))
3351           {
3352             // the line is a comment (as per the RFC 2483)
3353             continue;
3354           }
3355           java.net.URI uri = new java.net.URI(s);
3356           if (uri.getScheme().toLowerCase(Locale.ROOT).startsWith("http"))
3357           {
3358             protocols.add(DataSourceType.URL);
3359             files.add(uri.toString());
3360           }
3361           else
3362           {
3363             // otherwise preserve old behaviour: catch all for file objects
3364             java.io.File file = new java.io.File(uri);
3365             protocols.add(DataSourceType.FILE);
3366             files.add(file.toString());
3367           }
3368         }
3369       }
3370
3371       if (jalview.bin.Console.isDebugEnabled())
3372       {
3373         if (data == null || !added)
3374         {
3375
3376           if (t.getTransferDataFlavors() != null
3377                   && t.getTransferDataFlavors().length > 0)
3378           {
3379             jalview.bin.Console.debug(
3380                     "Couldn't resolve drop data. Here are the supported flavors:");
3381             for (DataFlavor fl : t.getTransferDataFlavors())
3382             {
3383               jalview.bin.Console.debug(
3384                       "Supported transfer dataflavor: " + fl.toString());
3385               Object df = t.getTransferData(fl);
3386               if (df != null)
3387               {
3388                 jalview.bin.Console.debug("Retrieves: " + df);
3389               }
3390               else
3391               {
3392                 jalview.bin.Console.debug("Retrieved nothing");
3393               }
3394             }
3395           }
3396           else
3397           {
3398             jalview.bin.Console
3399                     .debug("Couldn't resolve dataflavor for drop: "
3400                             + t.toString());
3401           }
3402         }
3403       }
3404     }
3405     if (Platform.isWindowsAndNotJS())
3406     {
3407       jalview.bin.Console
3408               .debug("Scanning dropped content for Windows Link Files");
3409
3410       // resolve any .lnk files in the file drop
3411       for (int f = 0; f < files.size(); f++)
3412       {
3413         String source = files.get(f).toString().toLowerCase(Locale.ROOT);
3414         if (protocols.get(f).equals(DataSourceType.FILE)
3415                 && (source.endsWith(".lnk") || source.endsWith(".url")
3416                         || source.endsWith(".site")))
3417         {
3418           try
3419           {
3420             Object obj = files.get(f);
3421             File lf = (obj instanceof File ? (File) obj
3422                     : new File((String) obj));
3423             // process link file to get a URL
3424             jalview.bin.Console.debug("Found potential link file: " + lf);
3425             WindowsShortcut wscfile = new WindowsShortcut(lf);
3426             String fullname = wscfile.getRealFilename();
3427             protocols.set(f, FormatAdapter.checkProtocol(fullname));
3428             files.set(f, fullname);
3429             jalview.bin.Console.debug("Parsed real filename " + fullname
3430                     + " to extract protocol: " + protocols.get(f));
3431           } catch (Exception ex)
3432           {
3433             jalview.bin.Console.error(
3434                     "Couldn't parse " + files.get(f) + " as a link file.",
3435                     ex);
3436           }
3437         }
3438       }
3439     }
3440   }
3441
3442   /**
3443    * Sets the Preferences property for experimental features to True or False
3444    * depending on the state of the controlling menu item
3445    */
3446   @Override
3447   protected void showExperimental_actionPerformed(boolean selected)
3448   {
3449     Cache.setProperty(EXPERIMENTAL_FEATURES, Boolean.toString(selected));
3450   }
3451
3452   /**
3453    * Answers a (possibly empty) list of any structure viewer frames (currently
3454    * for either Jmol or Chimera) which are currently open. This may optionally
3455    * be restricted to viewers of a specified class, or viewers linked to a
3456    * specified alignment panel.
3457    *
3458    * @param apanel
3459    *          if not null, only return viewers linked to this panel
3460    * @param structureViewerClass
3461    *          if not null, only return viewers of this class
3462    * @return
3463    */
3464   public List<StructureViewerBase> getStructureViewers(
3465           AlignmentPanel apanel,
3466           Class<? extends StructureViewerBase> structureViewerClass)
3467   {
3468     List<StructureViewerBase> result = new ArrayList<>();
3469     JInternalFrame[] frames = Desktop.instance.getAllFrames();
3470
3471     for (JInternalFrame frame : frames)
3472     {
3473       if (frame instanceof StructureViewerBase)
3474       {
3475         if (structureViewerClass == null
3476                 || structureViewerClass.isInstance(frame))
3477         {
3478           if (apanel == null
3479                   || ((StructureViewerBase) frame).isLinkedWith(apanel))
3480           {
3481             result.add((StructureViewerBase) frame);
3482           }
3483         }
3484       }
3485     }
3486     return result;
3487   }
3488
3489   public static final String debugScaleMessage = "Desktop graphics transform scale=";
3490
3491   private static boolean debugScaleMessageDone = false;
3492
3493   public static void debugScaleMessage(Graphics g)
3494   {
3495     if (debugScaleMessageDone)
3496     {
3497       return;
3498     }
3499     // output used by tests to check HiDPI scaling settings in action
3500     try
3501     {
3502       Graphics2D gg = (Graphics2D) g;
3503       if (gg != null)
3504       {
3505         AffineTransform t = gg.getTransform();
3506         double scaleX = t.getScaleX();
3507         double scaleY = t.getScaleY();
3508         jalview.bin.Console.debug(debugScaleMessage + scaleX + " (X)");
3509         jalview.bin.Console.debug(debugScaleMessage + scaleY + " (Y)");
3510         debugScaleMessageDone = true;
3511       }
3512       else
3513       {
3514         jalview.bin.Console.debug("Desktop graphics null");
3515       }
3516     } catch (Exception e)
3517     {
3518       jalview.bin.Console.debug(Cache.getStackTraceString(e));
3519     }
3520   }
3521 }