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