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