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