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