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