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