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