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