JAL-1517 formatting/tidy
[jalview.git] / src / jalview / gui / Desktop.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
3  * Copyright (C) 2014 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.bin.Cache;
24 import jalview.io.FileLoader;
25 import jalview.io.FormatAdapter;
26 import jalview.io.IdentifyFile;
27 import jalview.io.JalviewFileChooser;
28 import jalview.io.JalviewFileView;
29 import jalview.structure.StructureSelectionManager;
30 import jalview.util.ImageMaker;
31 import jalview.util.MessageManager;
32 import jalview.ws.params.ParamManager;
33
34 import java.awt.BorderLayout;
35 import java.awt.Color;
36 import java.awt.Dimension;
37 import java.awt.FontMetrics;
38 import java.awt.Graphics;
39 import java.awt.GridLayout;
40 import java.awt.Point;
41 import java.awt.Rectangle;
42 import java.awt.Toolkit;
43 import java.awt.datatransfer.Clipboard;
44 import java.awt.datatransfer.ClipboardOwner;
45 import java.awt.datatransfer.DataFlavor;
46 import java.awt.datatransfer.Transferable;
47 import java.awt.dnd.DnDConstants;
48 import java.awt.dnd.DropTargetDragEvent;
49 import java.awt.dnd.DropTargetDropEvent;
50 import java.awt.dnd.DropTargetEvent;
51 import java.awt.dnd.DropTargetListener;
52 import java.awt.event.ActionEvent;
53 import java.awt.event.ActionListener;
54 import java.awt.event.FocusEvent;
55 import java.awt.event.FocusListener;
56 import java.awt.event.MouseAdapter;
57 import java.awt.event.MouseEvent;
58 import java.awt.event.MouseListener;
59 import java.awt.event.WindowAdapter;
60 import java.awt.event.WindowEvent;
61 import java.beans.PropertyChangeEvent;
62 import java.beans.PropertyChangeListener;
63 import java.beans.PropertyVetoException;
64 import java.io.BufferedInputStream;
65 import java.io.File;
66 import java.io.FileOutputStream;
67 import java.lang.reflect.Constructor;
68 import java.net.URL;
69 import java.util.ArrayList;
70 import java.util.Hashtable;
71 import java.util.StringTokenizer;
72 import java.util.Vector;
73 import java.util.concurrent.ExecutorService;
74 import java.util.concurrent.Executors;
75 import java.util.concurrent.Semaphore;
76
77 import javax.swing.DefaultDesktopManager;
78 import javax.swing.DesktopManager;
79 import javax.swing.JButton;
80 import javax.swing.JComboBox;
81 import javax.swing.JComponent;
82 import javax.swing.JDesktopPane;
83 import javax.swing.JFrame;
84 import javax.swing.JInternalFrame;
85 import javax.swing.JLabel;
86 import javax.swing.JMenuItem;
87 import javax.swing.JOptionPane;
88 import javax.swing.JPanel;
89 import javax.swing.JPopupMenu;
90 import javax.swing.JProgressBar;
91 import javax.swing.SwingUtilities;
92 import javax.swing.event.HyperlinkEvent;
93 import javax.swing.event.HyperlinkEvent.EventType;
94 import javax.swing.event.MenuEvent;
95 import javax.swing.event.MenuListener;
96
97 /**
98  * Jalview Desktop
99  * 
100  * 
101  * @author $author$
102  * @version $Revision: 1.155 $
103  */
104 public class Desktop extends jalview.jbgui.GDesktop implements
105         DropTargetListener, ClipboardOwner, IProgressIndicator,
106         jalview.api.StructureSelectionManagerProvider
107 {
108
109   private JalviewChangeSupport changeSupport = new JalviewChangeSupport();
110
111   /**
112    * news reader - null if it was never started.
113    */
114   private BlogReader jvnews = null;
115
116   /**
117    * @param listener
118    * @see jalview.gui.JalviewChangeSupport#addJalviewPropertyChangeListener(java.beans.PropertyChangeListener)
119    */
120   public void addJalviewPropertyChangeListener(
121           PropertyChangeListener listener)
122   {
123     changeSupport.addJalviewPropertyChangeListener(listener);
124   }
125
126   /**
127    * @param propertyName
128    * @param listener
129    * @see jalview.gui.JalviewChangeSupport#addJalviewPropertyChangeListener(java.lang.String,
130    *      java.beans.PropertyChangeListener)
131    */
132   public void addJalviewPropertyChangeListener(String propertyName,
133           PropertyChangeListener listener)
134   {
135     changeSupport.addJalviewPropertyChangeListener(propertyName, listener);
136   }
137
138   /**
139    * @param propertyName
140    * @param listener
141    * @see jalview.gui.JalviewChangeSupport#removeJalviewPropertyChangeListener(java.lang.String,
142    *      java.beans.PropertyChangeListener)
143    */
144   public void removeJalviewPropertyChangeListener(String propertyName,
145           PropertyChangeListener listener)
146   {
147     changeSupport.removeJalviewPropertyChangeListener(propertyName,
148             listener);
149   }
150
151   /** Singleton Desktop instance */
152   public static Desktop instance;
153
154   public static MyDesktopPane desktop;
155
156   static int openFrameCount = 0;
157
158   static final int xOffset = 30;
159
160   static final int yOffset = 30;
161
162   public static jalview.ws.jws1.Discoverer discoverer;
163
164   public static Object[] jalviewClipboard;
165
166   public static boolean internalCopy = false;
167
168   static int fileLoadingCount = 0;
169
170   class MyDesktopManager implements DesktopManager
171   {
172
173     private DesktopManager delegate;
174
175     public MyDesktopManager(DesktopManager delegate)
176     {
177       this.delegate = delegate;
178     }
179
180     public void activateFrame(JInternalFrame f)
181     {
182       try
183       {
184         delegate.activateFrame(f);
185       } catch (NullPointerException npe)
186       {
187         Point p = getMousePosition();
188         instance.showPasteMenu(p.x, p.y);
189       }
190     }
191
192     public void beginDraggingFrame(JComponent f)
193     {
194       delegate.beginDraggingFrame(f);
195     }
196
197     public void beginResizingFrame(JComponent f, int direction)
198     {
199       delegate.beginResizingFrame(f, direction);
200     }
201
202     public void closeFrame(JInternalFrame f)
203     {
204       delegate.closeFrame(f);
205     }
206
207     public void deactivateFrame(JInternalFrame f)
208     {
209       delegate.deactivateFrame(f);
210     }
211
212     public void deiconifyFrame(JInternalFrame f)
213     {
214       delegate.deiconifyFrame(f);
215     }
216
217     public void dragFrame(JComponent f, int newX, int newY)
218     {
219       if (newY < 0)
220       {
221         newY = 0;
222       }
223       delegate.dragFrame(f, newX, newY);
224     }
225
226     public void endDraggingFrame(JComponent f)
227     {
228       delegate.endDraggingFrame(f);
229     }
230
231     public void endResizingFrame(JComponent f)
232     {
233       delegate.endResizingFrame(f);
234     }
235
236     public void iconifyFrame(JInternalFrame f)
237     {
238       delegate.iconifyFrame(f);
239     }
240
241     public void maximizeFrame(JInternalFrame f)
242     {
243       delegate.maximizeFrame(f);
244     }
245
246     public void minimizeFrame(JInternalFrame f)
247     {
248       delegate.minimizeFrame(f);
249     }
250
251     public void openFrame(JInternalFrame f)
252     {
253       delegate.openFrame(f);
254     }
255
256     public void resizeFrame(JComponent f, int newX, int newY, int newWidth,
257             int newHeight)
258     {
259       Rectangle b = desktop.getBounds();
260       if (newY < 0)
261       {
262         newY = 0;
263       }
264       delegate.resizeFrame(f, newX, newY, newWidth, newHeight);
265     }
266
267     public void setBoundsForFrame(JComponent f, int newX, int newY,
268             int newWidth, int newHeight)
269     {
270       delegate.setBoundsForFrame(f, newX, newY, newWidth, newHeight);
271     }
272
273     // All other methods, simply delegate
274
275   }
276
277   /**
278    * Creates a new Desktop object.
279    */
280   public Desktop()
281   {
282     /**
283      * A note to implementors. It is ESSENTIAL that any activities that might
284      * block are spawned off as threads rather than waited for during this
285      * constructor.
286      */
287     instance = this;
288     doVamsasClientCheck();
289     doGroovyCheck();
290     doConfigureStructurePrefs();
291     setTitle("Jalview " + jalview.bin.Cache.getProperty("VERSION"));
292     setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
293     boolean selmemusage = jalview.bin.Cache.getDefault("SHOW_MEMUSAGE",
294             false);
295     boolean showjconsole = jalview.bin.Cache.getDefault(
296             "SHOW_JAVA_CONSOLE", false);
297     desktop = new MyDesktopPane(selmemusage);
298     showMemusage.setSelected(selmemusage);
299     desktop.setBackground(Color.white);
300     getContentPane().setLayout(new BorderLayout());
301     // alternate config - have scrollbars - see notes in JAL-153
302     // JScrollPane sp = new JScrollPane();
303     // sp.getViewport().setView(desktop);
304     // getContentPane().add(sp, BorderLayout.CENTER);
305     getContentPane().add(desktop, BorderLayout.CENTER);
306     desktop.setDragMode(JDesktopPane.OUTLINE_DRAG_MODE);
307
308     // This line prevents Windows Look&Feel resizing all new windows to maximum
309     // if previous window was maximised
310     desktop.setDesktopManager(new MyDesktopManager(
311             new DefaultDesktopManager()));
312
313     Rectangle dims = getLastKnownDimensions("");
314     if (dims != null)
315     {
316       setBounds(dims);
317     }
318     else
319     {
320       Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
321       setBounds((screenSize.width - 900) / 2,
322               (screenSize.height - 650) / 2, 900, 650);
323     }
324     jconsole = new Console(this, showjconsole);
325     // add essential build information
326     jconsole.setHeader("Jalview Version: "
327             + jalview.bin.Cache.getProperty("VERSION") + "\n"
328             + "Jalview Installation: "
329             + jalview.bin.Cache.getDefault("INSTALLATION", "unknown")
330             + "\n"
331             + "Build Date: "
332             + jalview.bin.Cache.getDefault("BUILD_DATE", "unknown") + "\n"
333             + "Java version: " + System.getProperty("java.version") + "\n"
334             + System.getProperty("os.arch") + " "
335             + System.getProperty("os.name") + " "
336             + System.getProperty("os.version"));
337
338     showConsole(showjconsole);
339
340     showNews.setVisible(false);
341
342     this.addWindowListener(new WindowAdapter()
343     {
344       public void windowClosing(WindowEvent evt)
345       {
346         quit();
347       }
348     });
349
350     MouseAdapter ma;
351     this.addMouseListener(ma = new MouseAdapter()
352     {
353       public void mousePressed(MouseEvent evt)
354       {
355         if (SwingUtilities.isRightMouseButton(evt))
356         {
357           showPasteMenu(evt.getX(), evt.getY());
358         }
359       }
360     });
361     desktop.addMouseListener(ma);
362
363     this.addFocusListener(new FocusListener()
364     {
365
366       @Override
367       public void focusLost(FocusEvent e)
368       {
369         // TODO Auto-generated method stub
370
371       }
372
373       @Override
374       public void focusGained(FocusEvent e)
375       {
376         Cache.log.debug("Relaying windows after focus gain");
377         // make sure that we sort windows properly after we gain focus
378         instance.relayerWindows();
379       }
380     });
381     this.setDropTarget(new java.awt.dnd.DropTarget(desktop, this));
382     // Spawn a thread that shows the splashscreen
383     SwingUtilities.invokeLater(new Runnable()
384     {
385       public void run()
386       {
387         new SplashScreen();
388       }
389     });
390
391     // displayed.
392     // Thread off a new instance of the file chooser - this reduces the time it
393     // takes to open it later on.
394     new Thread(new Runnable()
395     {
396       public void run()
397       {
398         Cache.log.debug("Filechooser init thread started.");
399         JalviewFileChooser chooser = new JalviewFileChooser(
400                 jalview.bin.Cache.getProperty("LAST_DIRECTORY"),
401                 jalview.io.AppletFormatAdapter.READABLE_EXTENSIONS,
402                 jalview.io.AppletFormatAdapter.READABLE_FNAMES,
403                 jalview.bin.Cache.getProperty("DEFAULT_FILE_FORMAT"));
404         Cache.log.debug("Filechooser init thread finished.");
405       }
406     }).start();
407     // Add the service change listener
408     changeSupport.addJalviewPropertyChangeListener("services",
409             new PropertyChangeListener()
410             {
411
412               @Override
413               public void propertyChange(PropertyChangeEvent evt)
414               {
415                 Cache.log.debug("Firing service changed event for "
416                         + evt.getNewValue());
417                 JalviewServicesChanged(evt);
418               }
419
420             });
421   }
422
423   public void doConfigureStructurePrefs()
424   {
425     // configure services
426     StructureSelectionManager ssm = StructureSelectionManager
427             .getStructureSelectionManager(this);
428     if (jalview.bin.Cache.getDefault(Preferences.ADD_SS_ANN, true))
429     {
430       ssm.setAddTempFacAnnot(jalview.bin.Cache.getDefault(
431               Preferences.ADD_TEMPFACT_ANN, true));
432     ssm.setProcessSecondaryStructure(jalview.bin.Cache.getDefault(Preferences.STRUCT_FROM_PDB, true));
433     ssm.setSecStructServices(jalview.bin.Cache.getDefault(Preferences.USE_RNAVIEW,
434             true));
435     }
436     else
437     {
438       ssm.setAddTempFacAnnot(false);
439       ssm.setProcessSecondaryStructure(false);
440       ssm.setSecStructServices(false);
441     }
442   }
443
444   public void checkForNews()
445   {
446     final Desktop me = this;
447     // Thread off the news reader, in case there are connection problems.
448     addDialogThread(new Runnable()
449     {
450       @Override
451       public void run()
452       {
453         Cache.log.debug("Starting news thread.");
454
455         jvnews = new BlogReader(me);
456         showNews.setVisible(true);
457         Cache.log.debug("Completed news thread.");
458       }
459     });
460   }
461
462   protected void showNews_actionPerformed(ActionEvent e)
463   {
464     showNews(showNews.isSelected());
465   }
466
467   void showNews(boolean visible)
468   {
469     {
470       Cache.log.debug((visible ? "Showing" : "Hiding") + " news.");
471       showNews.setSelected(visible);
472       if (visible && !jvnews.isVisible())
473       {
474         new Thread(new Runnable()
475         {
476           @Override
477           public void run()
478           {
479             long instance = System.currentTimeMillis();
480             Desktop.instance.setProgressBar(MessageManager.getString("status.refreshing_news"), instance);
481             jvnews.refreshNews();
482             Desktop.instance.setProgressBar(null, instance);
483             jvnews.showNews();
484           }
485         }).start();
486       }
487     }
488   }
489
490   /**
491    * recover the last known dimensions for a jalview window
492    * 
493    * @param windowName
494    *          - empty string is desktop, all other windows have unique prefix
495    * @return null or last known dimensions scaled to current geometry (if last
496    *         window geom was known)
497    */
498   Rectangle getLastKnownDimensions(String windowName)
499   {
500     // TODO: lock aspect ratio for scaling desktop Bug #0058199
501     Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
502     String x = jalview.bin.Cache.getProperty(windowName + "SCREEN_X");
503     String y = jalview.bin.Cache.getProperty(windowName + "SCREEN_Y");
504     String width = jalview.bin.Cache.getProperty(windowName
505             + "SCREEN_WIDTH");
506     String height = jalview.bin.Cache.getProperty(windowName
507             + "SCREEN_HEIGHT");
508     if ((x != null) && (y != null) && (width != null) && (height != null))
509     {
510       int ix = Integer.parseInt(x), iy = Integer.parseInt(y), iw = Integer
511               .parseInt(width), ih = Integer.parseInt(height);
512       if (jalview.bin.Cache.getProperty("SCREENGEOMETRY_WIDTH") != null)
513       {
514         // attempt #1 - try to cope with change in screen geometry - this
515         // version doesn't preserve original jv aspect ratio.
516         // take ratio of current screen size vs original screen size.
517         double sw = ((1f * screenSize.width) / (1f * Integer
518                 .parseInt(jalview.bin.Cache
519                         .getProperty("SCREENGEOMETRY_WIDTH"))));
520         double sh = ((1f * screenSize.height) / (1f * Integer
521                 .parseInt(jalview.bin.Cache
522                         .getProperty("SCREENGEOMETRY_HEIGHT"))));
523         // rescale the bounds depending upon the current screen geometry.
524         ix = (int) (ix * sw);
525         iw = (int) (iw * sw);
526         iy = (int) (iy * sh);
527         ih = (int) (ih * sh);
528         while (ix >= screenSize.width)
529         {
530           jalview.bin.Cache.log
531                   .debug("Window geometry location recall error: shifting horizontal to within screenbounds.");
532           ix -= screenSize.width;
533         }
534         while (iy >= screenSize.height)
535         {
536           jalview.bin.Cache.log
537                   .debug("Window geometry location recall error: shifting vertical to within screenbounds.");
538           iy -= screenSize.height;
539         }
540         jalview.bin.Cache.log.debug("Got last known dimensions for "
541                 + windowName + ": x:" + ix + " y:" + iy + " width:" + iw
542                 + " height:" + ih);
543       }
544       // return dimensions for new instance
545       return new Rectangle(ix, iy, iw, ih);
546     }
547     return null;
548   }
549
550   private void doVamsasClientCheck()
551   {
552     if (jalview.bin.Cache.vamsasJarsPresent())
553     {
554       setupVamsasDisconnectedGui();
555       VamsasMenu.setVisible(true);
556       final Desktop us = this;
557       VamsasMenu.addMenuListener(new MenuListener()
558       {
559         // this listener remembers when the menu was first selected, and
560         // doesn't rebuild the session list until it has been cleared and
561         // reselected again.
562         boolean refresh = true;
563
564         public void menuCanceled(MenuEvent e)
565         {
566           refresh = true;
567         }
568
569         public void menuDeselected(MenuEvent e)
570         {
571           refresh = true;
572         }
573
574         public void menuSelected(MenuEvent e)
575         {
576           if (refresh)
577           {
578             us.buildVamsasStMenu();
579             refresh = false;
580           }
581         }
582       });
583       vamsasStart.setVisible(true);
584     }
585   }
586
587   void showPasteMenu(int x, int y)
588   {
589     JPopupMenu popup = new JPopupMenu();
590     JMenuItem item = new JMenuItem(
591             MessageManager.getString("label.paste_new_window"));
592     item.addActionListener(new ActionListener()
593     {
594       public void actionPerformed(ActionEvent evt)
595       {
596         paste();
597       }
598     });
599
600     popup.add(item);
601     popup.show(this, x, y);
602   }
603
604   public void paste()
605   {
606     try
607     {
608       Clipboard c = Toolkit.getDefaultToolkit().getSystemClipboard();
609       Transferable contents = c.getContents(this);
610
611       if (contents != null)
612       {
613         String file = (String) contents
614                 .getTransferData(DataFlavor.stringFlavor);
615
616         String format = new IdentifyFile().Identify(file,
617                 FormatAdapter.PASTE);
618
619         new FileLoader().LoadFile(file, FormatAdapter.PASTE, format);
620
621       }
622     } catch (Exception ex)
623     {
624       System.out
625               .println("Unable to paste alignment from system clipboard:\n"
626                       + ex);
627     }
628   }
629
630   /**
631    * Adds and opens the given frame to the desktop
632    * 
633    * @param frame
634    *          DOCUMENT ME!
635    * @param title
636    *          DOCUMENT ME!
637    * @param w
638    *          DOCUMENT ME!
639    * @param h
640    *          DOCUMENT ME!
641    */
642   public static synchronized void addInternalFrame(
643           final JInternalFrame frame, String title, int w, int h)
644   {
645     addInternalFrame(frame, title, w, h, true);
646   }
647
648   /**
649    * DOCUMENT ME!
650    * 
651    * @param frame
652    *          DOCUMENT ME!
653    * @param title
654    *          DOCUMENT ME!
655    * @param w
656    *          DOCUMENT ME!
657    * @param h
658    *          DOCUMENT ME!
659    * @param resizable
660    *          DOCUMENT ME!
661    */
662   public static synchronized void addInternalFrame(
663           final JInternalFrame frame, String title, int w, int h,
664           boolean resizable)
665   {
666
667     // TODO: allow callers to determine X and Y position of frame (eg. via
668     // bounds object).
669     // TODO: consider fixing method to update entries in the window submenu with
670     // the current window title
671
672     frame.setTitle(title);
673     if (frame.getWidth() < 1 || frame.getHeight() < 1)
674     {
675       frame.setSize(w, h);
676     }
677     // THIS IS A PUBLIC STATIC METHOD, SO IT MAY BE CALLED EVEN IN
678     // A HEADLESS STATE WHEN NO DESKTOP EXISTS. MUST RETURN
679     // IF JALVIEW IS RUNNING HEADLESS
680     // ///////////////////////////////////////////////
681     if (instance == null
682             || (System.getProperty("java.awt.headless") != null && System
683                     .getProperty("java.awt.headless").equals("true")))
684     {
685       return;
686     }
687
688     openFrameCount++;
689
690     frame.setVisible(true);
691     frame.setClosable(true);
692     frame.setResizable(resizable);
693     frame.setMaximizable(resizable);
694     frame.setIconifiable(resizable);
695     frame.setFrameIcon(null);
696
697     if (frame.getX() < 1 && frame.getY() < 1)
698     {
699       frame.setLocation(xOffset * openFrameCount, yOffset
700               * ((openFrameCount - 1) % 10) + yOffset);
701     }
702
703     final JMenuItem menuItem = new JMenuItem(title);
704     frame.addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
705     {
706       public void internalFrameActivated(
707               javax.swing.event.InternalFrameEvent evt)
708       {
709         JInternalFrame itf = desktop.getSelectedFrame();
710         if (itf != null)
711         {
712           itf.requestFocus();
713         }
714
715       }
716
717       public void internalFrameClosed(
718               javax.swing.event.InternalFrameEvent evt)
719       {
720         PaintRefresher.RemoveComponent(frame);
721         openFrameCount--;
722         windowMenu.remove(menuItem);
723         JInternalFrame itf = desktop.getSelectedFrame();
724         if (itf != null)
725         {
726           itf.requestFocus();
727         }
728         System.gc();
729       };
730     });
731
732     menuItem.addActionListener(new ActionListener()
733     {
734       public void actionPerformed(ActionEvent e)
735       {
736         try
737         {
738           frame.setSelected(true);
739           frame.setIcon(false);
740         } catch (java.beans.PropertyVetoException ex)
741         {
742
743         }
744       }
745     });
746     menuItem.addMouseListener(new MouseListener()
747     {
748
749       @Override
750       public void mouseReleased(MouseEvent e)
751       {
752       }
753
754       @Override
755       public void mousePressed(MouseEvent e)
756       {
757       }
758
759       @Override
760       public void mouseExited(MouseEvent e)
761       {
762         try
763         {
764           frame.setSelected(false);
765         } catch (PropertyVetoException e1)
766         {
767         }
768       }
769
770       @Override
771       public void mouseEntered(MouseEvent e)
772       {
773         try
774         {
775           frame.setSelected(true);
776         } catch (PropertyVetoException e1)
777         {
778         }
779       }
780
781       @Override
782       public void mouseClicked(MouseEvent e)
783       {
784
785       }
786     });
787
788     windowMenu.add(menuItem);
789
790     desktop.add(frame);
791     frame.toFront();
792     try
793     {
794       frame.setSelected(true);
795       frame.requestFocus();
796     } catch (java.beans.PropertyVetoException ve)
797     {
798     } catch (java.lang.ClassCastException cex)
799     {
800       Cache.log
801               .warn("Squashed a possible GUI implementation error. If you can recreate this, please look at http://issues.jalview.org/browse/JAL-869",
802                       cex);
803     }
804   }
805
806   public void lostOwnership(Clipboard clipboard, Transferable contents)
807   {
808     if (!internalCopy)
809     {
810       Desktop.jalviewClipboard = null;
811     }
812
813     internalCopy = false;
814   }
815
816   public void dragEnter(DropTargetDragEvent evt)
817   {
818   }
819
820   public void dragExit(DropTargetEvent evt)
821   {
822   }
823
824   public void dragOver(DropTargetDragEvent evt)
825   {
826   }
827
828   public void dropActionChanged(DropTargetDragEvent evt)
829   {
830   }
831
832   /**
833    * DOCUMENT ME!
834    * 
835    * @param evt
836    *          DOCUMENT ME!
837    */
838   public void drop(DropTargetDropEvent evt)
839   {
840     boolean success = true;
841     Transferable t = evt.getTransferable();
842     java.util.List files = null;
843     java.util.List protocols = null;
844
845     try
846     {
847       DataFlavor uriListFlavor = new DataFlavor(
848               "text/uri-list;class=java.lang.String");
849       if (t.isDataFlavorSupported(DataFlavor.javaFileListFlavor))
850       {
851         // Works on Windows and MacOSX
852         evt.acceptDrop(DnDConstants.ACTION_COPY_OR_MOVE);
853         files = (java.util.List) t
854                 .getTransferData(DataFlavor.javaFileListFlavor);
855       }
856       else if (t.isDataFlavorSupported(uriListFlavor))
857       {
858         // This is used by Unix drag system
859         evt.acceptDrop(DnDConstants.ACTION_COPY_OR_MOVE);
860         String data = (String) t.getTransferData(uriListFlavor);
861         files = new java.util.ArrayList(1);
862         protocols = new java.util.ArrayList(1);
863         for (java.util.StringTokenizer st = new java.util.StringTokenizer(
864                 data, "\r\n"); st.hasMoreTokens();)
865         {
866           String s = st.nextToken();
867           if (s.startsWith("#"))
868           {
869             // the line is a comment (as per the RFC 2483)
870             continue;
871           }
872           java.net.URI uri = new java.net.URI(s);
873           if (uri.getScheme().toLowerCase().startsWith("http"))
874           {
875             protocols.add(FormatAdapter.URL);
876             files.add(uri.toString());
877           }
878           else
879           {
880             // otherwise preserve old behaviour: catch all for file objects
881             java.io.File file = new java.io.File(uri);
882             protocols.add(FormatAdapter.FILE);
883             files.add(file.toString());
884           }
885         }
886       }
887     } catch (Exception e)
888     {
889       success = false;
890     }
891
892     if (files != null)
893     {
894       try
895       {
896         for (int i = 0; i < files.size(); i++)
897         {
898           String file = files.get(i).toString();
899           String protocol = (protocols == null) ? FormatAdapter.FILE
900                   : (String) protocols.get(i);
901           String format = null;
902
903           if (file.endsWith(".jar"))
904           {
905             format = "Jalview";
906
907           }
908           else
909           {
910             format = new IdentifyFile().Identify(file, protocol);
911           }
912
913           new FileLoader().LoadFile(file, protocol, format);
914
915         }
916       } catch (Exception ex)
917       {
918         success = false;
919       }
920     }
921     evt.dropComplete(success); // need this to ensure input focus is properly
922                                // transfered to any new windows created
923   }
924
925   /**
926    * DOCUMENT ME!
927    * 
928    * @param e
929    *          DOCUMENT ME!
930    */
931   public void inputLocalFileMenuItem_actionPerformed(AlignViewport viewport)
932   {
933     JalviewFileChooser chooser = new JalviewFileChooser(
934             jalview.bin.Cache.getProperty("LAST_DIRECTORY"),
935             jalview.io.AppletFormatAdapter.READABLE_EXTENSIONS,
936             jalview.io.AppletFormatAdapter.READABLE_FNAMES,
937             jalview.bin.Cache.getProperty("DEFAULT_FILE_FORMAT"));
938
939     chooser.setFileView(new JalviewFileView());
940     chooser.setDialogTitle(MessageManager
941             .getString("label.open_local_file"));
942     chooser.setToolTipText(MessageManager.getString("action.open"));
943
944     int value = chooser.showOpenDialog(this);
945
946     if (value == JalviewFileChooser.APPROVE_OPTION)
947     {
948       String choice = chooser.getSelectedFile().getPath();
949       jalview.bin.Cache.setProperty("LAST_DIRECTORY", chooser
950               .getSelectedFile().getParent());
951
952       String format = null;
953       if (chooser.getSelectedFormat() != null
954               && chooser.getSelectedFormat().equals("Jalview"))
955       {
956         format = "Jalview";
957       }
958       else
959       {
960         format = new IdentifyFile().Identify(choice, FormatAdapter.FILE);
961       }
962
963       if (viewport != null)
964       {
965         new FileLoader().LoadFile(viewport, choice, FormatAdapter.FILE,
966                 format);
967       }
968       else
969       {
970         new FileLoader().LoadFile(choice, FormatAdapter.FILE, format);
971       }
972     }
973   }
974
975   /**
976    * DOCUMENT ME!
977    * 
978    * @param e
979    *          DOCUMENT ME!
980    */
981   public void inputURLMenuItem_actionPerformed(AlignViewport viewport)
982   {
983     // This construct allows us to have a wider textfield
984     // for viewing
985     JLabel label = new JLabel(
986             MessageManager.getString("label.input_file_url"));
987     final JComboBox history = new JComboBox();
988
989     JPanel panel = new JPanel(new GridLayout(2, 1));
990     panel.add(label);
991     panel.add(history);
992     history.setPreferredSize(new Dimension(400, 20));
993     history.setEditable(true);
994     history.addItem("http://www.");
995
996     String historyItems = jalview.bin.Cache.getProperty("RECENT_URL");
997
998     StringTokenizer st;
999
1000     if (historyItems != null)
1001     {
1002       st = new StringTokenizer(historyItems, "\t");
1003
1004       while (st.hasMoreTokens())
1005       {
1006         history.addItem(st.nextElement());
1007       }
1008     }
1009
1010     int reply = JOptionPane.showInternalConfirmDialog(desktop, panel,
1011             MessageManager.getString("label.input_alignment_from_url"),
1012             JOptionPane.OK_CANCEL_OPTION);
1013
1014     if (reply != JOptionPane.OK_OPTION)
1015     {
1016       return;
1017     }
1018
1019     String url = history.getSelectedItem().toString();
1020
1021     if (url.toLowerCase().endsWith(".jar"))
1022     {
1023       if (viewport != null)
1024       {
1025         new FileLoader().LoadFile(viewport, url, FormatAdapter.URL,
1026                 "Jalview");
1027       }
1028       else
1029       {
1030         new FileLoader().LoadFile(url, FormatAdapter.URL, "Jalview");
1031       }
1032     }
1033     else
1034     {
1035       String format = new IdentifyFile().Identify(url, FormatAdapter.URL);
1036
1037       if (format.equals("URL NOT FOUND"))
1038       {
1039         JOptionPane.showInternalMessageDialog(Desktop.desktop,
1040                 MessageManager.formatMessage("label.couldnt_locate", new String[]{url}), MessageManager.getString("label.url_not_found"),
1041                 JOptionPane.WARNING_MESSAGE);
1042
1043         return;
1044       }
1045
1046       if (viewport != null)
1047       {
1048         new FileLoader().LoadFile(viewport, url, FormatAdapter.URL, format);
1049       }
1050       else
1051       {
1052         new FileLoader().LoadFile(url, FormatAdapter.URL, format);
1053       }
1054     }
1055   }
1056
1057   /**
1058    * DOCUMENT ME!
1059    * 
1060    * @param e
1061    *          DOCUMENT ME!
1062    */
1063   public void inputTextboxMenuItem_actionPerformed(AlignViewport viewport)
1064   {
1065     CutAndPasteTransfer cap = new CutAndPasteTransfer();
1066     cap.setForInput(viewport);
1067     Desktop.addInternalFrame(cap,
1068             MessageManager.getString("label.cut_paste_alignmen_file"),
1069             true, 600, 500);
1070   }
1071
1072   /*
1073    * Exit the program
1074    */
1075   public void quit()
1076   {
1077     Dimension screen = Toolkit.getDefaultToolkit().getScreenSize();
1078     jalview.bin.Cache
1079             .setProperty("SCREENGEOMETRY_WIDTH", screen.width + "");
1080     jalview.bin.Cache.setProperty("SCREENGEOMETRY_HEIGHT", screen.height
1081             + "");
1082     storeLastKnownDimensions("", new Rectangle(getBounds().x,
1083             getBounds().y, getWidth(), getHeight()));
1084
1085     if (jconsole != null)
1086     {
1087       storeLastKnownDimensions("JAVA_CONSOLE_", jconsole.getBounds());
1088       jconsole.stopConsole();
1089     }
1090     if (jvnews != null)
1091     {
1092       storeLastKnownDimensions("JALVIEW_RSS_WINDOW_", jvnews.getBounds());
1093
1094     }
1095     if (dialogExecutor != null)
1096     {
1097       dialogExecutor.shutdownNow();
1098     }
1099
1100     System.exit(0);
1101   }
1102
1103   private void storeLastKnownDimensions(String string, Rectangle jc)
1104   {
1105     jalview.bin.Cache.log.debug("Storing last known dimensions for "
1106             + string + ": x:" + jc.x + " y:" + jc.y + " width:" + jc.width
1107             + " height:" + jc.height);
1108
1109     jalview.bin.Cache.setProperty(string + "SCREEN_X", jc.x + "");
1110     jalview.bin.Cache.setProperty(string + "SCREEN_Y", jc.y + "");
1111     jalview.bin.Cache.setProperty(string + "SCREEN_WIDTH", jc.width + "");
1112     jalview.bin.Cache.setProperty(string + "SCREEN_HEIGHT", jc.height + "");
1113   }
1114
1115   /**
1116    * DOCUMENT ME!
1117    * 
1118    * @param e
1119    *          DOCUMENT ME!
1120    */
1121   public void aboutMenuItem_actionPerformed(ActionEvent e)
1122   {
1123     // StringBuffer message = getAboutMessage(false);
1124     // JOptionPane.showInternalMessageDialog(Desktop.desktop,
1125     //
1126     // message.toString(), "About Jalview", JOptionPane.INFORMATION_MESSAGE);
1127     new Thread(new Runnable()
1128     {
1129       public void run()
1130       {
1131         new SplashScreen(true);
1132       }
1133     }).start();
1134   }
1135
1136   public StringBuffer getAboutMessage(boolean shortv)
1137   {
1138     StringBuffer message = new StringBuffer();
1139     message.append("<html>");
1140     if (shortv)
1141     {
1142       message.append("<h1><strong>Version: "
1143               + jalview.bin.Cache.getProperty("VERSION")
1144               + "</strong></h1>");
1145       message.append("<strong>Last Updated: <em>"
1146               + jalview.bin.Cache.getDefault("BUILD_DATE", "unknown")
1147               + "</em></strong>");
1148
1149     }
1150     else
1151     {
1152
1153       message.append("<strong>Version "
1154               + jalview.bin.Cache.getProperty("VERSION")
1155               + "; last updated: "
1156               + jalview.bin.Cache.getDefault("BUILD_DATE", "unknown"));
1157     }
1158
1159     if (jalview.bin.Cache.getDefault("LATEST_VERSION", "Checking").equals(
1160             "Checking"))
1161     {
1162       message.append("<br>...Checking latest version...</br>");
1163     }
1164     else if (!jalview.bin.Cache.getDefault("LATEST_VERSION", "Checking")
1165             .equals(jalview.bin.Cache.getProperty("VERSION")))
1166     {
1167       boolean red = false;
1168       if (jalview.bin.Cache.getProperty("VERSION").toLowerCase()
1169               .indexOf("automated build") == -1)
1170       {
1171         red = true;
1172         // Displayed when code version and jnlp version do not match and code
1173         // version is not a development build
1174         message.append("<div style=\"color: #FF0000;font-style: bold;\">");
1175       }
1176
1177       message.append("<br>!! Version "
1178               + jalview.bin.Cache.getDefault("LATEST_VERSION",
1179                       "..Checking..")
1180               + " is available for download from "
1181               + jalview.bin.Cache.getDefault("www.jalview.org",
1182                       "http://www.jalview.org") + " !!");
1183       if (red)
1184       {
1185         message.append("</div>");
1186       }
1187     }
1188     message.append("<br>Authors:  "
1189             + jalview.bin.Cache
1190                     .getDefault(
1191                             "AUTHORFNAMES",
1192                             "The Jalview Authors (See AUTHORS file for current list)")
1193             + "<br><br>Development managed by The Barton Group, University of Dundee, Scotland, UK.<br>"
1194             + "<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"
1195             + "<br><br>If  you use Jalview, please cite:"
1196             + "<br>Waterhouse, A.M., Procter, J.B., Martin, D.M.A, Clamp, M. and Barton, G. J. (2009)"
1197             + "<br>Jalview Version 2 - a multiple sequence alignment editor and analysis workbench"
1198             + "<br>Bioinformatics doi: 10.1093/bioinformatics/btp033"
1199             + "</html>");
1200     return message;
1201   }
1202
1203   /**
1204    * DOCUMENT ME!
1205    * 
1206    * @param e
1207    *          DOCUMENT ME!
1208    */
1209   public void documentationMenuItem_actionPerformed(ActionEvent e)
1210   {
1211     try
1212     {
1213       Help.showHelpWindow();
1214     } catch (Exception ex)
1215     {
1216     }
1217   }
1218
1219   public void closeAll_actionPerformed(ActionEvent e)
1220   {
1221     JInternalFrame[] frames = desktop.getAllFrames();
1222     for (int i = 0; i < frames.length; i++)
1223     {
1224       try
1225       {
1226         frames[i].setClosed(true);
1227       } catch (java.beans.PropertyVetoException ex)
1228       {
1229       }
1230     }
1231     System.out.println("ALL CLOSED");
1232     if (v_client != null)
1233     {
1234       // TODO clear binding to vamsas document objects on close_all
1235
1236     }
1237   }
1238
1239   public void raiseRelated_actionPerformed(ActionEvent e)
1240   {
1241     reorderAssociatedWindows(false, false);
1242   }
1243
1244   public void minimizeAssociated_actionPerformed(ActionEvent e)
1245   {
1246     reorderAssociatedWindows(true, false);
1247   }
1248
1249   void closeAssociatedWindows()
1250   {
1251     reorderAssociatedWindows(false, true);
1252   }
1253
1254   /*
1255    * (non-Javadoc)
1256    * 
1257    * @seejalview.jbgui.GDesktop#garbageCollect_actionPerformed(java.awt.event.
1258    * ActionEvent)
1259    */
1260   protected void garbageCollect_actionPerformed(ActionEvent e)
1261   {
1262     // We simply collect the garbage
1263     jalview.bin.Cache.log.debug("Collecting garbage...");
1264     System.gc();
1265     jalview.bin.Cache.log.debug("Finished garbage collection.");
1266   }
1267
1268   /*
1269    * (non-Javadoc)
1270    * 
1271    * @see
1272    * jalview.jbgui.GDesktop#showMemusage_actionPerformed(java.awt.event.ActionEvent
1273    * )
1274    */
1275   protected void showMemusage_actionPerformed(ActionEvent e)
1276   {
1277     desktop.showMemoryUsage(showMemusage.isSelected());
1278   }
1279
1280   /*
1281    * (non-Javadoc)
1282    * 
1283    * @see
1284    * jalview.jbgui.GDesktop#showConsole_actionPerformed(java.awt.event.ActionEvent
1285    * )
1286    */
1287   protected void showConsole_actionPerformed(ActionEvent e)
1288   {
1289     showConsole(showConsole.isSelected());
1290   }
1291
1292   Console jconsole = null;
1293
1294   /**
1295    * control whether the java console is visible or not
1296    * 
1297    * @param selected
1298    */
1299   void showConsole(boolean selected)
1300   {
1301     showConsole.setSelected(selected);
1302     // TODO: decide if we should update properties file
1303     Cache.setProperty("SHOW_JAVA_CONSOLE", Boolean.valueOf(selected)
1304             .toString());
1305     jconsole.setVisible(selected);
1306   }
1307
1308   void reorderAssociatedWindows(boolean minimize, boolean close)
1309   {
1310     JInternalFrame[] frames = desktop.getAllFrames();
1311     if (frames == null || frames.length < 1)
1312     {
1313       return;
1314     }
1315
1316     AlignViewport source = null, target = null;
1317     if (frames[0] instanceof AlignFrame)
1318     {
1319       source = ((AlignFrame) frames[0]).getCurrentView();
1320     }
1321     else if (frames[0] instanceof TreePanel)
1322     {
1323       source = ((TreePanel) frames[0]).getViewPort();
1324     }
1325     else if (frames[0] instanceof PCAPanel)
1326     {
1327       source = ((PCAPanel) frames[0]).av;
1328     }
1329     else if (frames[0].getContentPane() instanceof PairwiseAlignPanel)
1330     {
1331       source = ((PairwiseAlignPanel) frames[0].getContentPane()).av;
1332     }
1333
1334     if (source != null)
1335     {
1336       for (int i = 0; i < frames.length; i++)
1337       {
1338         target = null;
1339         if (frames[i] == null)
1340         {
1341           continue;
1342         }
1343         if (frames[i] instanceof AlignFrame)
1344         {
1345           target = ((AlignFrame) frames[i]).getCurrentView();
1346         }
1347         else if (frames[i] instanceof TreePanel)
1348         {
1349           target = ((TreePanel) frames[i]).getViewPort();
1350         }
1351         else if (frames[i] instanceof PCAPanel)
1352         {
1353           target = ((PCAPanel) frames[i]).av;
1354         }
1355         else if (frames[i].getContentPane() instanceof PairwiseAlignPanel)
1356         {
1357           target = ((PairwiseAlignPanel) frames[i].getContentPane()).av;
1358         }
1359
1360         if (source == target)
1361         {
1362           try
1363           {
1364             if (close)
1365             {
1366               frames[i].setClosed(true);
1367             }
1368             else
1369             {
1370               frames[i].setIcon(minimize);
1371               if (!minimize)
1372               {
1373                 frames[i].toFront();
1374               }
1375             }
1376
1377           } catch (java.beans.PropertyVetoException ex)
1378           {
1379           }
1380         }
1381       }
1382     }
1383   }
1384
1385   /**
1386    * DOCUMENT ME!
1387    * 
1388    * @param e
1389    *          DOCUMENT ME!
1390    */
1391   protected void preferences_actionPerformed(ActionEvent e)
1392   {
1393     new Preferences();
1394   }
1395
1396   /**
1397    * DOCUMENT ME!
1398    * 
1399    * @param e
1400    *          DOCUMENT ME!
1401    */
1402   public void saveState_actionPerformed(ActionEvent e)
1403   {
1404     JalviewFileChooser chooser = new JalviewFileChooser(
1405             jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
1406             { "jvp" }, new String[]
1407             { "Jalview Project" }, "Jalview Project");
1408
1409     chooser.setFileView(new JalviewFileView());
1410     chooser.setDialogTitle(MessageManager.getString("label.save_state"));
1411
1412     int value = chooser.showSaveDialog(this);
1413
1414     if (value == JalviewFileChooser.APPROVE_OPTION)
1415     {
1416       final Desktop me = this;
1417       final java.io.File choice = chooser.getSelectedFile();
1418       new Thread(new Runnable()
1419       {
1420         public void run()
1421         {
1422
1423           setProgressBar(MessageManager.formatMessage("label.saving_jalview_project", new String[]{choice.getName()}),
1424                   choice.hashCode());
1425           jalview.bin.Cache.setProperty("LAST_DIRECTORY",
1426                   choice.getParent());
1427           // TODO catch and handle errors for savestate
1428           // TODO prevent user from messing with the Desktop whilst we're saving
1429           try
1430           {
1431             new Jalview2XML().SaveState(choice);
1432           } catch (OutOfMemoryError oom)
1433           {
1434             new OOMWarning("Whilst saving current state to "
1435                     + choice.getName(), oom);
1436           } catch (Exception ex)
1437           {
1438             Cache.log.error(
1439                     "Problems whilst trying to save to " + choice.getName(),
1440                     ex);
1441             JOptionPane.showMessageDialog(
1442                     me,
1443                     MessageManager.formatMessage("label.error_whilst_saving_current_state_to", new String[]{ choice.getName()}),
1444                     MessageManager.getString("label.couldnt_save_project"),
1445                     JOptionPane.WARNING_MESSAGE);
1446           }
1447           setProgressBar(null, choice.hashCode());
1448         }
1449       }).start();
1450     }
1451   }
1452
1453   /**
1454    * DOCUMENT ME!
1455    * 
1456    * @param e
1457    *          DOCUMENT ME!
1458    */
1459   public void loadState_actionPerformed(ActionEvent e)
1460   {
1461     JalviewFileChooser chooser = new JalviewFileChooser(
1462             jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
1463             { "jvp", "jar" }, new String[]
1464             { "Jalview Project", "Jalview Project (old)" },
1465             "Jalview Project");
1466     chooser.setFileView(new JalviewFileView());
1467     chooser.setDialogTitle(MessageManager.getString("label.restore_state"));
1468
1469     int value = chooser.showOpenDialog(this);
1470
1471     if (value == JalviewFileChooser.APPROVE_OPTION)
1472     {
1473       final String choice = chooser.getSelectedFile().getAbsolutePath();
1474       jalview.bin.Cache.setProperty("LAST_DIRECTORY", chooser
1475               .getSelectedFile().getParent());
1476       new Thread(new Runnable()
1477       {
1478         public void run()
1479         {
1480           setProgressBar(MessageManager.formatMessage("label.loading_jalview_project", new String[]{choice}),
1481                   choice.hashCode());
1482           try
1483           {
1484             new Jalview2XML().LoadJalviewAlign(choice);
1485           } catch (OutOfMemoryError oom)
1486           {
1487             new OOMWarning("Whilst loading project from " + choice, oom);
1488           } catch (Exception ex)
1489           {
1490             Cache.log.error("Problems whilst loading project from "
1491                     + choice, ex);
1492             JOptionPane.showMessageDialog(Desktop.desktop,
1493                         MessageManager.formatMessage("label.error_whilst_loading_project_from", new String[]{choice}),
1494                     MessageManager.getString("label.couldnt_load_project"), JOptionPane.WARNING_MESSAGE);
1495           }
1496           setProgressBar(null, choice.hashCode());
1497         }
1498       }).start();
1499     }
1500   }
1501
1502   public void inputSequence_actionPerformed(ActionEvent e)
1503   {
1504     new SequenceFetcher(this);
1505   }
1506
1507   JPanel progressPanel;
1508
1509   ArrayList<JPanel> fileLoadingPanels = new ArrayList<JPanel>();
1510
1511   public void startLoading(final String fileName)
1512   {
1513     if (fileLoadingCount == 0)
1514     {
1515       fileLoadingPanels.add(addProgressPanel(MessageManager.formatMessage("label.loading_file", new String[]{fileName})));
1516     }
1517     fileLoadingCount++;
1518   }
1519
1520   private JPanel addProgressPanel(String string)
1521   {
1522     if (progressPanel == null)
1523     {
1524       progressPanel = new JPanel(new GridLayout(1, 1));
1525       totalProgressCount = 0;
1526       instance.getContentPane().add(progressPanel, BorderLayout.SOUTH);
1527     }
1528     JPanel thisprogress = new JPanel(new BorderLayout(10, 5));
1529     JProgressBar progressBar = new JProgressBar();
1530     progressBar.setIndeterminate(true);
1531
1532     thisprogress.add(new JLabel(string), BorderLayout.WEST);
1533
1534     thisprogress.add(progressBar, BorderLayout.CENTER);
1535     progressPanel.add(thisprogress);
1536     ((GridLayout) progressPanel.getLayout())
1537             .setRows(((GridLayout) progressPanel.getLayout()).getRows() + 1);
1538     ++totalProgressCount;
1539     instance.validate();
1540     return thisprogress;
1541   }
1542
1543   int totalProgressCount = 0;
1544
1545   private void removeProgressPanel(JPanel progbar)
1546   {
1547     if (progressPanel != null)
1548     {
1549       synchronized (progressPanel)
1550       {
1551         progressPanel.remove(progbar);
1552         GridLayout gl = (GridLayout) progressPanel.getLayout();
1553         gl.setRows(gl.getRows() - 1);
1554         if (--totalProgressCount < 1)
1555         {
1556           this.getContentPane().remove(progressPanel);
1557           progressPanel = null;
1558         }
1559       }
1560     }
1561     validate();
1562   }
1563
1564   public void stopLoading()
1565   {
1566     fileLoadingCount--;
1567     if (fileLoadingCount < 1)
1568     {
1569       while (fileLoadingPanels.size() > 0)
1570       {
1571         removeProgressPanel(fileLoadingPanels.remove(0));
1572       }
1573       fileLoadingPanels.clear();
1574       fileLoadingCount = 0;
1575     }
1576     validate();
1577   }
1578
1579   public static int getViewCount(String alignmentId)
1580   {
1581     AlignViewport[] aps = getViewports(alignmentId);
1582     return (aps == null) ? 0 : aps.length;
1583   }
1584
1585   /**
1586    * 
1587    * @param alignmentId
1588    * @return all AlignmentPanels concerning the alignmentId sequence set
1589    */
1590   public static AlignmentPanel[] getAlignmentPanels(String alignmentId)
1591   {
1592     int count = 0;
1593     if (Desktop.desktop == null)
1594     {
1595       // no frames created and in headless mode
1596       // TODO: verify that frames are recoverable when in headless mode
1597       return null;
1598     }
1599     JInternalFrame[] frames = Desktop.desktop.getAllFrames();
1600     ArrayList aps = new ArrayList();
1601     for (int t = 0; t < frames.length; t++)
1602     {
1603       if (frames[t] instanceof AlignFrame)
1604       {
1605         AlignFrame af = (AlignFrame) frames[t];
1606         for (int a = 0; a < af.alignPanels.size(); a++)
1607         {
1608           if (alignmentId.equals(((AlignmentPanel) af.alignPanels
1609                   .elementAt(a)).av.getSequenceSetId()))
1610           {
1611             aps.add(af.alignPanels.elementAt(a));
1612           }
1613         }
1614       }
1615     }
1616     if (aps.size() == 0)
1617     {
1618       return null;
1619     }
1620     AlignmentPanel[] vap = new AlignmentPanel[aps.size()];
1621     for (int t = 0; t < vap.length; t++)
1622     {
1623       vap[t] = (AlignmentPanel) aps.get(t);
1624     }
1625     return vap;
1626   }
1627
1628   /**
1629    * get all the viewports on an alignment.
1630    * 
1631    * @param sequenceSetId
1632    *          unique alignment id
1633    * @return all viewports on the alignment bound to sequenceSetId
1634    */
1635   public static AlignViewport[] getViewports(String sequenceSetId)
1636   {
1637     Vector viewp = new Vector();
1638     if (desktop != null)
1639     {
1640       javax.swing.JInternalFrame[] frames = instance.getAllFrames();
1641
1642       for (int t = 0; t < frames.length; t++)
1643       {
1644         if (frames[t] instanceof AlignFrame)
1645         {
1646           AlignFrame afr = ((AlignFrame) frames[t]);
1647           if (afr.getViewport().getSequenceSetId().equals(sequenceSetId))
1648           {
1649             if (afr.alignPanels != null)
1650             {
1651               for (int a = 0; a < afr.alignPanels.size(); a++)
1652               {
1653                 if (sequenceSetId.equals(((AlignmentPanel) afr.alignPanels
1654                         .elementAt(a)).av.getSequenceSetId()))
1655                 {
1656                   viewp.addElement(((AlignmentPanel) afr.alignPanels
1657                           .elementAt(a)).av);
1658                 }
1659               }
1660             }
1661             else
1662             {
1663               viewp.addElement(((AlignFrame) frames[t]).getViewport());
1664             }
1665           }
1666         }
1667       }
1668       if (viewp.size() > 0)
1669       {
1670         AlignViewport[] vp = new AlignViewport[viewp.size()];
1671         viewp.copyInto(vp);
1672         return vp;
1673       }
1674     }
1675     return null;
1676   }
1677
1678   public void explodeViews(AlignFrame af)
1679   {
1680     int size = af.alignPanels.size();
1681     if (size < 2)
1682     {
1683       return;
1684     }
1685
1686     for (int i = 0; i < size; i++)
1687     {
1688       AlignmentPanel ap = (AlignmentPanel) af.alignPanels.elementAt(i);
1689       AlignFrame newaf = new AlignFrame(ap);
1690       if (ap.av.explodedPosition != null
1691               && !ap.av.explodedPosition.equals(af.getBounds()))
1692       {
1693         newaf.setBounds(ap.av.explodedPosition);
1694       }
1695
1696       ap.av.gatherViewsHere = false;
1697
1698       addInternalFrame(newaf, af.getTitle(), AlignFrame.DEFAULT_WIDTH,
1699               AlignFrame.DEFAULT_HEIGHT);
1700     }
1701
1702     af.alignPanels.clear();
1703     af.closeMenuItem_actionPerformed(true);
1704
1705   }
1706
1707   public void gatherViews(AlignFrame source)
1708   {
1709     source.viewport.gatherViewsHere = true;
1710     source.viewport.explodedPosition = source.getBounds();
1711     JInternalFrame[] frames = desktop.getAllFrames();
1712     String viewId = source.viewport.getSequenceSetId();
1713
1714     for (int t = 0; t < frames.length; t++)
1715     {
1716       if (frames[t] instanceof AlignFrame && frames[t] != source)
1717       {
1718         AlignFrame af = (AlignFrame) frames[t];
1719         boolean gatherThis = false;
1720         for (int a = 0; a < af.alignPanels.size(); a++)
1721         {
1722           AlignmentPanel ap = (AlignmentPanel) af.alignPanels.elementAt(a);
1723           if (viewId.equals(ap.av.getSequenceSetId()))
1724           {
1725             gatherThis = true;
1726             ap.av.gatherViewsHere = false;
1727             ap.av.explodedPosition = af.getBounds();
1728             source.addAlignmentPanel(ap, false);
1729           }
1730         }
1731
1732         if (gatherThis)
1733         {
1734           af.alignPanels.clear();
1735           af.closeMenuItem_actionPerformed(true);
1736         }
1737       }
1738     }
1739
1740   }
1741
1742   jalview.gui.VamsasApplication v_client = null;
1743
1744   public void vamsasImport_actionPerformed(ActionEvent e)
1745   {
1746     if (v_client == null)
1747     {
1748       // Load and try to start a session.
1749       JalviewFileChooser chooser = new JalviewFileChooser(
1750               jalview.bin.Cache.getProperty("LAST_DIRECTORY"));
1751
1752       chooser.setFileView(new JalviewFileView());
1753       chooser.setDialogTitle(MessageManager.getString("label.open_saved_vamsas_session"));
1754       chooser.setToolTipText(MessageManager
1755               .getString("label.select_vamsas_session_opened_as_new_vamsas_session"));
1756
1757       int value = chooser.showOpenDialog(this);
1758
1759       if (value == JalviewFileChooser.APPROVE_OPTION)
1760       {
1761         String fle = chooser.getSelectedFile().toString();
1762         if (!vamsasImport(chooser.getSelectedFile()))
1763         {
1764           JOptionPane
1765                   .showInternalMessageDialog(
1766                           Desktop.desktop,
1767                           MessageManager.formatMessage(
1768                                   "label.couldnt_import_as_vamsas_session",
1769                                   new String[]
1770                                   { fle }),
1771                           MessageManager
1772                                   .getString("label.vamsas_document_import_failed"),
1773                           JOptionPane.ERROR_MESSAGE);
1774         }
1775       }
1776     }
1777     else
1778     {
1779       jalview.bin.Cache.log
1780               .error("Implementation error - load session from a running session is not supported.");
1781     }
1782   }
1783
1784   /**
1785    * import file into a new vamsas session (uses jalview.gui.VamsasApplication)
1786    * 
1787    * @param file
1788    * @return true if import was a success and a session was started.
1789    */
1790   public boolean vamsasImport(URL url)
1791   {
1792     // TODO: create progress bar
1793     if (v_client != null)
1794     {
1795
1796       jalview.bin.Cache.log
1797               .error("Implementation error - load session from a running session is not supported.");
1798       return false;
1799     }
1800
1801     try
1802     {
1803       // copy the URL content to a temporary local file
1804       // TODO: be a bit cleverer here with nio (?!)
1805       File file = File.createTempFile("vdocfromurl", ".vdj");
1806       FileOutputStream fos = new FileOutputStream(file);
1807       BufferedInputStream bis = new BufferedInputStream(url.openStream());
1808       byte[] buffer = new byte[2048];
1809       int ln;
1810       while ((ln = bis.read(buffer)) > -1)
1811       {
1812         fos.write(buffer, 0, ln);
1813       }
1814       bis.close();
1815       fos.close();
1816       v_client = new jalview.gui.VamsasApplication(this, file,
1817               url.toExternalForm());
1818     } catch (Exception ex)
1819     {
1820       jalview.bin.Cache.log.error(
1821               "Failed to create new vamsas session from contents of URL "
1822                       + url, ex);
1823       return false;
1824     }
1825     setupVamsasConnectedGui();
1826     v_client.initial_update(); // TODO: thread ?
1827     return v_client.inSession();
1828   }
1829
1830   /**
1831    * import file into a new vamsas session (uses jalview.gui.VamsasApplication)
1832    * 
1833    * @param file
1834    * @return true if import was a success and a session was started.
1835    */
1836   public boolean vamsasImport(File file)
1837   {
1838     if (v_client != null)
1839     {
1840
1841       jalview.bin.Cache.log
1842               .error("Implementation error - load session from a running session is not supported.");
1843       return false;
1844     }
1845
1846     setProgressBar(MessageManager.formatMessage("status.importing_vamsas_session_from", new String[]{file.getName()}),
1847             file.hashCode());
1848     try
1849     {
1850       v_client = new jalview.gui.VamsasApplication(this, file, null);
1851     } catch (Exception ex)
1852     {
1853         setProgressBar(MessageManager.formatMessage("status.importing_vamsas_session_from", new String[]{file.getName()}),
1854                 file.hashCode());
1855       jalview.bin.Cache.log.error(
1856               "New vamsas session from existing session file failed:", ex);
1857       return false;
1858     }
1859     setupVamsasConnectedGui();
1860     v_client.initial_update(); // TODO: thread ?
1861     setProgressBar(MessageManager.formatMessage("status.importing_vamsas_session_from", new String[]{file.getName()}),
1862             file.hashCode());
1863     return v_client.inSession();
1864   }
1865
1866   public boolean joinVamsasSession(String mysesid)
1867   {
1868     if (v_client != null)
1869     {
1870       throw new Error(MessageManager.getString("error.try_join_vamsas_session_another"));
1871     }
1872     if (mysesid == null)
1873     {
1874       throw new Error(MessageManager.getString("error.invalid_vamsas_session_id"));
1875     }
1876     v_client = new VamsasApplication(this, mysesid);
1877     setupVamsasConnectedGui();
1878     v_client.initial_update();
1879     return (v_client.inSession());
1880   }
1881
1882   public void vamsasStart_actionPerformed(ActionEvent e)
1883   {
1884     if (v_client == null)
1885     {
1886       // Start a session.
1887       // we just start a default session for moment.
1888       /*
1889        * JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache.
1890        * getProperty("LAST_DIRECTORY"));
1891        * 
1892        * chooser.setFileView(new JalviewFileView());
1893        * chooser.setDialogTitle("Load Vamsas file");
1894        * chooser.setToolTipText("Import");
1895        * 
1896        * int value = chooser.showOpenDialog(this);
1897        * 
1898        * if (value == JalviewFileChooser.APPROVE_OPTION) { v_client = new
1899        * jalview.gui.VamsasApplication(this, chooser.getSelectedFile());
1900        */
1901       v_client = new VamsasApplication(this);
1902       setupVamsasConnectedGui();
1903       v_client.initial_update(); // TODO: thread ?
1904     }
1905     else
1906     {
1907       // store current data in session.
1908       v_client.push_update(); // TODO: thread
1909     }
1910   }
1911
1912   protected void setupVamsasConnectedGui()
1913   {
1914     vamsasStart.setText(MessageManager.getString("label.session_update"));
1915     vamsasSave.setVisible(true);
1916     vamsasStop.setVisible(true);
1917     vamsasImport.setVisible(false); // Document import to existing session is
1918     // not possible for vamsas-client-1.0.
1919   }
1920
1921   protected void setupVamsasDisconnectedGui()
1922   {
1923     vamsasSave.setVisible(false);
1924     vamsasStop.setVisible(false);
1925     vamsasImport.setVisible(true);
1926     vamsasStart.setText(MessageManager
1927             .getString("label.new_vamsas_session"));
1928   }
1929
1930   public void vamsasStop_actionPerformed(ActionEvent e)
1931   {
1932     if (v_client != null)
1933     {
1934       v_client.end_session();
1935       v_client = null;
1936       setupVamsasDisconnectedGui();
1937     }
1938   }
1939
1940   protected void buildVamsasStMenu()
1941   {
1942     if (v_client == null)
1943     {
1944       String[] sess = null;
1945       try
1946       {
1947         sess = VamsasApplication.getSessionList();
1948       } catch (Exception e)
1949       {
1950         jalview.bin.Cache.log.warn(
1951                 "Problem getting current sessions list.", e);
1952         sess = null;
1953       }
1954       if (sess != null)
1955       {
1956         jalview.bin.Cache.log.debug("Got current sessions list: "
1957                 + sess.length + " entries.");
1958         VamsasStMenu.removeAll();
1959         for (int i = 0; i < sess.length; i++)
1960         {
1961           JMenuItem sessit = new JMenuItem();
1962           sessit.setText(sess[i]);
1963           sessit.setToolTipText(MessageManager.formatMessage(
1964                   "label.connect_to_session", new String[]
1965                   { sess[i] }));
1966           final Desktop dsktp = this;
1967           final String mysesid = sess[i];
1968           sessit.addActionListener(new ActionListener()
1969           {
1970
1971             public void actionPerformed(ActionEvent e)
1972             {
1973               if (dsktp.v_client == null)
1974               {
1975                 Thread rthr = new Thread(new Runnable()
1976                 {
1977
1978                   public void run()
1979                   {
1980                     dsktp.v_client = new VamsasApplication(dsktp, mysesid);
1981                     dsktp.setupVamsasConnectedGui();
1982                     dsktp.v_client.initial_update();
1983                   }
1984
1985                 });
1986                 rthr.start();
1987               }
1988             };
1989           });
1990           VamsasStMenu.add(sessit);
1991         }
1992         // don't show an empty menu.
1993         VamsasStMenu.setVisible(sess.length > 0);
1994
1995       }
1996       else
1997       {
1998         jalview.bin.Cache.log.debug("No current vamsas sessions.");
1999         VamsasStMenu.removeAll();
2000         VamsasStMenu.setVisible(false);
2001       }
2002     }
2003     else
2004     {
2005       // Not interested in the content. Just hide ourselves.
2006       VamsasStMenu.setVisible(false);
2007     }
2008   }
2009
2010   public void vamsasSave_actionPerformed(ActionEvent e)
2011   {
2012     if (v_client != null)
2013     {
2014       JalviewFileChooser chooser = new JalviewFileChooser(
2015               jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
2016               { "vdj" }, // TODO: VAMSAS DOCUMENT EXTENSION is VDJ
2017               new String[]
2018               { "Vamsas Document" }, "Vamsas Document");
2019
2020       chooser.setFileView(new JalviewFileView());
2021       chooser.setDialogTitle(MessageManager.getString("label.save_vamsas_document_archive"));
2022
2023       int value = chooser.showSaveDialog(this);
2024
2025       if (value == JalviewFileChooser.APPROVE_OPTION)
2026       {
2027         java.io.File choice = chooser.getSelectedFile();
2028         JPanel progpanel = addProgressPanel(MessageManager.formatMessage("label.saving_vamsas_doc", new String[]{choice.getName()}));
2029         jalview.bin.Cache.setProperty("LAST_DIRECTORY", choice.getParent());
2030         String warnmsg = null;
2031         String warnttl = null;
2032         try
2033         {
2034           v_client.vclient.storeDocument(choice);
2035         } catch (Error ex)
2036         {
2037           warnttl = "Serious Problem saving Vamsas Document";
2038           warnmsg = ex.toString();
2039           jalview.bin.Cache.log.error("Error Whilst saving document to "
2040                   + choice, ex);
2041
2042         } catch (Exception ex)
2043         {
2044           warnttl = "Problem saving Vamsas Document.";
2045           warnmsg = ex.toString();
2046           jalview.bin.Cache.log.warn("Exception Whilst saving document to "
2047                   + choice, ex);
2048
2049         }
2050         removeProgressPanel(progpanel);
2051         if (warnmsg != null)
2052         {
2053           JOptionPane.showInternalMessageDialog(Desktop.desktop,
2054
2055           warnmsg, warnttl, JOptionPane.ERROR_MESSAGE);
2056         }
2057       }
2058     }
2059   }
2060
2061   JPanel vamUpdate = null;
2062
2063   /**
2064    * hide vamsas user gui bits when a vamsas document event is being handled.
2065    * 
2066    * @param b
2067    *          true to hide gui, false to reveal gui
2068    */
2069   public void setVamsasUpdate(boolean b)
2070   {
2071     jalview.bin.Cache.log.debug("Setting gui for Vamsas update "
2072             + (b ? "in progress" : "finished"));
2073
2074     if (vamUpdate != null)
2075     {
2076       this.removeProgressPanel(vamUpdate);
2077     }
2078     if (b)
2079     {
2080       vamUpdate = this.addProgressPanel(MessageManager.getString("label.updating_vamsas_session"));
2081     }
2082     vamsasStart.setVisible(!b);
2083     vamsasStop.setVisible(!b);
2084     vamsasSave.setVisible(!b);
2085   }
2086
2087   public JInternalFrame[] getAllFrames()
2088   {
2089     return desktop.getAllFrames();
2090   }
2091
2092   /**
2093    * Checks the given url to see if it gives a response indicating that the user
2094    * should be informed of a new questionnaire.
2095    * 
2096    * @param url
2097    */
2098   public void checkForQuestionnaire(String url)
2099   {
2100     UserQuestionnaireCheck jvq = new UserQuestionnaireCheck(url);
2101     // javax.swing.SwingUtilities.invokeLater(jvq);
2102     new Thread(jvq).start();
2103   }
2104
2105   /**
2106    * Proxy class for JDesktopPane which optionally displays the current memory
2107    * usage and highlights the desktop area with a red bar if free memory runs
2108    * low.
2109    * 
2110    * @author AMW
2111    */
2112   public class MyDesktopPane extends JDesktopPane implements Runnable
2113   {
2114
2115     boolean showMemoryUsage = false;
2116
2117     Runtime runtime;
2118
2119     java.text.NumberFormat df;
2120
2121     float maxMemory, allocatedMemory, freeMemory, totalFreeMemory,
2122             percentUsage;
2123
2124     public MyDesktopPane(boolean showMemoryUsage)
2125     {
2126       showMemoryUsage(showMemoryUsage);
2127     }
2128
2129     public void showMemoryUsage(boolean showMemoryUsage)
2130     {
2131       this.showMemoryUsage = showMemoryUsage;
2132       if (showMemoryUsage)
2133       {
2134         Thread worker = new Thread(this);
2135         worker.start();
2136       }
2137     }
2138
2139     public boolean isShowMemoryUsage()
2140     {
2141       return showMemoryUsage;
2142     }
2143
2144     public void run()
2145     {
2146       df = java.text.NumberFormat.getNumberInstance();
2147       df.setMaximumFractionDigits(2);
2148       runtime = Runtime.getRuntime();
2149
2150       while (showMemoryUsage)
2151       {
2152         try
2153         {
2154           maxMemory = runtime.maxMemory() / 1048576f;
2155           allocatedMemory = runtime.totalMemory() / 1048576f;
2156           freeMemory = runtime.freeMemory() / 1048576f;
2157           totalFreeMemory = freeMemory + (maxMemory - allocatedMemory);
2158
2159           percentUsage = (totalFreeMemory / maxMemory) * 100;
2160
2161           // if (percentUsage < 20)
2162           {
2163             // border1 = BorderFactory.createMatteBorder(12, 12, 12, 12,
2164             // Color.red);
2165             // instance.set.setBorder(border1);
2166           }
2167           repaint();
2168           // sleep after showing usage
2169           Thread.sleep(3000);
2170         } catch (Exception ex)
2171         {
2172           ex.printStackTrace();
2173         }
2174       }
2175     }
2176
2177     public void paintComponent(Graphics g)
2178     {
2179       if (showMemoryUsage && g != null && df != null)
2180       {
2181         if (percentUsage < 20)
2182         {
2183           g.setColor(Color.red);
2184         }
2185         FontMetrics fm = g.getFontMetrics();
2186         if (fm != null)
2187         {
2188           g.drawString(MessageManager.formatMessage(
2189                   "label.memory_stats",
2190                   new String[]
2191                   { df.format(totalFreeMemory), df.format(maxMemory),
2192                       df.format(percentUsage) }), 10,
2193                   getHeight() - fm.getHeight());
2194         }
2195       }
2196     }
2197   }
2198
2199   /**
2200    * fixes stacking order after a modal dialog to ensure windows that should be
2201    * on top actually are
2202    */
2203   public void relayerWindows()
2204   {
2205
2206   }
2207
2208   protected JMenuItem groovyShell;
2209
2210   public void doGroovyCheck()
2211   {
2212     if (jalview.bin.Cache.groovyJarsPresent())
2213     {
2214       groovyShell = new JMenuItem();
2215       groovyShell.setText(MessageManager.getString("label.groovy_console"));
2216       groovyShell.addActionListener(new ActionListener()
2217       {
2218         public void actionPerformed(ActionEvent e)
2219         {
2220           groovyShell_actionPerformed(e);
2221         }
2222       });
2223       toolsMenu.add(groovyShell);
2224       groovyShell.setVisible(true);
2225     }
2226   }
2227
2228   /**
2229    * Accessor method to quickly get all the AlignmentFrames loaded.
2230    */
2231   public static AlignFrame[] getAlignframes()
2232   {
2233     JInternalFrame[] frames = Desktop.desktop.getAllFrames();
2234
2235     if (frames == null)
2236     {
2237       return null;
2238     }
2239     Vector avp = new Vector();
2240     try
2241     {
2242       // REVERSE ORDER
2243       for (int i = frames.length - 1; i > -1; i--)
2244       {
2245         if (frames[i] instanceof AlignFrame)
2246         {
2247           AlignFrame af = (AlignFrame) frames[i];
2248           avp.addElement(af);
2249         }
2250       }
2251     } catch (Exception ex)
2252     {
2253       ex.printStackTrace();
2254     }
2255     if (avp.size() == 0)
2256     {
2257       return null;
2258     }
2259     AlignFrame afs[] = new AlignFrame[avp.size()];
2260     for (int i = 0, j = avp.size(); i < j; i++)
2261     {
2262       afs[i] = (AlignFrame) avp.elementAt(i);
2263     }
2264     avp.clear();
2265     return afs;
2266   }
2267
2268   public AppJmol[] getJmols()
2269   {
2270     JInternalFrame[] frames = Desktop.desktop.getAllFrames();
2271
2272     if (frames == null)
2273     {
2274       return null;
2275     }
2276     Vector avp = new Vector();
2277     try
2278     {
2279       // REVERSE ORDER
2280       for (int i = frames.length - 1; i > -1; i--)
2281       {
2282         if (frames[i] instanceof AppJmol)
2283         {
2284           AppJmol af = (AppJmol) frames[i];
2285           avp.addElement(af);
2286         }
2287       }
2288     } catch (Exception ex)
2289     {
2290       ex.printStackTrace();
2291     }
2292     if (avp.size() == 0)
2293     {
2294       return null;
2295     }
2296     AppJmol afs[] = new AppJmol[avp.size()];
2297     for (int i = 0, j = avp.size(); i < j; i++)
2298     {
2299       afs[i] = (AppJmol) avp.elementAt(i);
2300     }
2301     avp.clear();
2302     return afs;
2303   }
2304
2305   /**
2306    * Add Groovy Support to Jalview
2307    */
2308   public void groovyShell_actionPerformed(ActionEvent e)
2309   {
2310     // use reflection to avoid creating compilation dependency.
2311     if (!jalview.bin.Cache.groovyJarsPresent())
2312     {
2313       throw new Error(MessageManager.getString("error.implementation_error_cannot_create_groovyshell"));
2314     }
2315     try
2316     {
2317       Class gcClass = Desktop.class.getClassLoader().loadClass(
2318               "groovy.ui.Console");
2319       Constructor gccons = gcClass.getConstructor(null);
2320       java.lang.reflect.Method setvar = gcClass.getMethod("setVariable",
2321               new Class[]
2322               { String.class, Object.class });
2323       java.lang.reflect.Method run = gcClass.getMethod("run", null);
2324       Object gc = gccons.newInstance(null);
2325       setvar.invoke(gc, new Object[]
2326       { "Jalview", this });
2327       run.invoke(gc, null);
2328     } catch (Exception ex)
2329     {
2330       jalview.bin.Cache.log.error("Groovy Shell Creation failed.", ex);
2331       JOptionPane
2332               .showInternalMessageDialog(
2333                       Desktop.desktop,
2334
2335                       MessageManager.getString("label.couldnt_create_groovy_shell"),
2336                       MessageManager.getString("label.groovy_support_failed"),
2337                       JOptionPane.ERROR_MESSAGE);
2338     }
2339   }
2340
2341   /**
2342    * Progress bars managed by the IProgressIndicator method.
2343    */
2344   private Hashtable<Long, JPanel> progressBars;
2345
2346   private Hashtable<Long, IProgressIndicatorHandler> progressBarHandlers;
2347
2348   /*
2349    * (non-Javadoc)
2350    * 
2351    * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
2352    */
2353   public void setProgressBar(String message, long id)
2354   {
2355     if (progressBars == null)
2356     {
2357       progressBars = new Hashtable<Long, JPanel>();
2358       progressBarHandlers = new Hashtable<Long, IProgressIndicatorHandler>();
2359     }
2360
2361     if (progressBars.get(new Long(id)) != null)
2362     {
2363       JPanel progressPanel = progressBars.remove(new Long(id));
2364       if (progressBarHandlers.contains(new Long(id)))
2365       {
2366         progressBarHandlers.remove(new Long(id));
2367       }
2368       removeProgressPanel(progressPanel);
2369     }
2370     else
2371     {
2372       progressBars.put(new Long(id), addProgressPanel(message));
2373     }
2374   }
2375
2376   /*
2377    * (non-Javadoc)
2378    * 
2379    * @see jalview.gui.IProgressIndicator#registerHandler(long,
2380    * jalview.gui.IProgressIndicatorHandler)
2381    */
2382   public void registerHandler(final long id,
2383           final IProgressIndicatorHandler handler)
2384   {
2385     if (progressBarHandlers == null || !progressBars.contains(new Long(id)))
2386     {
2387       throw new Error(MessageManager.getString("error.call_setprogressbar_before_registering_handler"));
2388     }
2389     progressBarHandlers.put(new Long(id), handler);
2390     final JPanel progressPanel = progressBars.get(new Long(id));
2391     if (handler.canCancel())
2392     {
2393       JButton cancel = new JButton(
2394               MessageManager.getString("action.cancel"));
2395       final IProgressIndicator us = this;
2396       cancel.addActionListener(new ActionListener()
2397       {
2398
2399         public void actionPerformed(ActionEvent e)
2400         {
2401           handler.cancelActivity(id);
2402           us.setProgressBar(MessageManager.formatMessage("label.cancelled_params", new String[]{((JLabel) progressPanel.getComponent(0)).getText()}), id);
2403         }
2404       });
2405       progressPanel.add(cancel, BorderLayout.EAST);
2406     }
2407   }
2408
2409   /**
2410    * 
2411    * @return true if any progress bars are still active
2412    */
2413   @Override
2414   public boolean operationInProgress()
2415   {
2416     if (progressBars != null && progressBars.size() > 0)
2417     {
2418       return true;
2419     }
2420     return false;
2421   }
2422
2423   /**
2424    * This will return the first AlignFrame viewing AlignViewport av. It will
2425    * break if there are more than one AlignFrames viewing a particular av. This
2426    * 
2427    * @param av
2428    * @return alignFrame for av
2429    */
2430   public static AlignFrame getAlignFrameFor(AlignViewport av)
2431   {
2432     if (desktop != null)
2433     {
2434       AlignmentPanel[] aps = getAlignmentPanels(av.getSequenceSetId());
2435       for (int panel = 0; aps != null && panel < aps.length; panel++)
2436       {
2437         if (aps[panel] != null && aps[panel].av == av)
2438         {
2439           return aps[panel].alignFrame;
2440         }
2441       }
2442     }
2443     return null;
2444   }
2445
2446   public VamsasApplication getVamsasApplication()
2447   {
2448     return v_client;
2449
2450   }
2451
2452   /**
2453    * flag set if jalview GUI is being operated programmatically
2454    */
2455   private boolean inBatchMode = false;
2456
2457   /**
2458    * check if jalview GUI is being operated programmatically
2459    * 
2460    * @return inBatchMode
2461    */
2462   public boolean isInBatchMode()
2463   {
2464     return inBatchMode;
2465   }
2466
2467   /**
2468    * set flag if jalview GUI is being operated programmatically
2469    * 
2470    * @param inBatchMode
2471    */
2472   public void setInBatchMode(boolean inBatchMode)
2473   {
2474     this.inBatchMode = inBatchMode;
2475   }
2476
2477   public void startServiceDiscovery()
2478   {
2479     startServiceDiscovery(false);
2480   }
2481
2482   public void startServiceDiscovery(boolean blocking)
2483   {
2484     boolean alive = true;
2485     Thread t0 = null, t1 = null, t2 = null;
2486     // JAL-940 - JALVIEW 1 services are now being EOLed as of JABA 2.1 release
2487     if (true)
2488     {
2489       // todo: changesupport handlers need to be transferred
2490       if (discoverer == null)
2491       {
2492         discoverer = new jalview.ws.jws1.Discoverer();
2493         // register PCS handler for desktop.
2494         discoverer.addPropertyChangeListener(changeSupport);
2495       }
2496       // JAL-940 - disabled JWS1 service configuration - always start discoverer
2497       // until we phase out completely
2498       (t0 = new Thread(discoverer)).start();
2499     }
2500
2501     // ENFIN services are EOLed as of Jalview 2.8.1 release
2502     if (false)
2503     {
2504       try
2505       {
2506         if (Cache.getDefault("SHOW_ENFIN_SERVICES", true))
2507         {
2508           // EnfinEnvision web service menu entries are rebuild every time the
2509           // menu is shown, so no changeSupport events are needed.
2510           jalview.ws.EnfinEnvision2OneWay.getInstance();
2511           (t1 = new Thread(jalview.ws.EnfinEnvision2OneWay.getInstance()))
2512                   .start();
2513         }
2514       } catch (Exception e)
2515       {
2516         Cache.log
2517                 .info("Exception when trying to launch Envision2 workflow discovery.",
2518                         e);
2519         Cache.log.info(e.getStackTrace());
2520       }
2521     }
2522
2523     if (Cache.getDefault("SHOW_JWS2_SERVICES", true))
2524     {
2525       if (jalview.ws.jws2.Jws2Discoverer.getDiscoverer().isRunning())
2526       {
2527         jalview.ws.jws2.Jws2Discoverer.getDiscoverer().setAborted(true);
2528       }
2529       t2 = jalview.ws.jws2.Jws2Discoverer.getDiscoverer().startDiscoverer(
2530               changeSupport);
2531
2532     }
2533     Thread t3 = null;
2534     {
2535       // TODO: do rest service discovery
2536     }
2537     if (blocking)
2538     {
2539       while (alive)
2540       {
2541         try
2542         {
2543           Thread.sleep(15);
2544         } catch (Exception e)
2545         {
2546         }
2547         alive = (t1 != null && t1.isAlive())
2548                 || (t2 != null && t2.isAlive())
2549                 || (t3 != null && t3.isAlive())
2550                 || (t0 != null && t0.isAlive());
2551       }
2552     }
2553   }
2554
2555   /**
2556    * called to check if the service discovery process completed successfully.
2557    * 
2558    * @param evt
2559    */
2560   protected void JalviewServicesChanged(PropertyChangeEvent evt)
2561   {
2562     if (evt.getNewValue() == null || evt.getNewValue() instanceof Vector)
2563     {
2564       final String ermsg = jalview.ws.jws2.Jws2Discoverer.getDiscoverer()
2565               .getErrorMessages();
2566       if (ermsg != null)
2567       {
2568         if (Cache.getDefault("SHOW_WSDISCOVERY_ERRORS", true))
2569         {
2570           if (serviceChangedDialog == null)
2571           {
2572             // only run if we aren't already displaying one of these.
2573             addDialogThread(serviceChangedDialog = new Runnable()
2574             {
2575               public void run()
2576               {
2577
2578                 /*
2579                  * JalviewDialog jd =new JalviewDialog() {
2580                  * 
2581                  * @Override protected void cancelPressed() { // TODO
2582                  * Auto-generated method stub
2583                  * 
2584                  * }@Override protected void okPressed() { // TODO
2585                  * Auto-generated method stub
2586                  * 
2587                  * }@Override protected void raiseClosed() { // TODO
2588                  * Auto-generated method stub
2589                  * 
2590                  * } }; jd.initDialogFrame(new
2591                  * JLabel("<html><table width=\"450\"><tr><td>" + ermsg +
2592                  * "<br/>It may be that you have invalid JABA URLs in your web service preferences,"
2593                  * + " or mis-configured HTTP proxy settings.<br/>" +
2594                  * "Check the <em>Connections</em> and <em>Web services</em> tab of the"
2595                  * +
2596                  * " Tools->Preferences dialog box to change them.</td></tr></table></html>"
2597                  * ), true, true, "Web Service Configuration Problem", 450,
2598                  * 400);
2599                  * 
2600                  * jd.waitForInput();
2601                  */
2602                 JOptionPane
2603                         .showConfirmDialog(
2604                                 Desktop.desktop,
2605                                 new JLabel(
2606                                         "<html><table width=\"450\"><tr><td>"
2607                                                 + ermsg
2608                                                 + "</td></tr></table>"
2609                                                 + "<p>It may be that you have invalid JABA URLs<br/>in your web service preferences,"
2610                                                 + "<br>or as a command-line argument, or mis-configured HTTP proxy settings.</p>"
2611                                                 + "<p>Check the <em>Connections</em> and <em>Web services</em> tab<br/>of the"
2612                                                 + " Tools->Preferences dialog box to change them.</p></html>"),
2613                                 "Web Service Configuration Problem",
2614                                 JOptionPane.DEFAULT_OPTION,
2615                                 JOptionPane.ERROR_MESSAGE);
2616                 serviceChangedDialog = null;
2617
2618               }
2619             });
2620           }
2621         }
2622         else
2623         {
2624           Cache.log
2625                   .error("Errors reported by JABA discovery service. Check web services preferences.\n"
2626                           + ermsg);
2627         }
2628       }
2629     }
2630   }
2631
2632   private Runnable serviceChangedDialog = null;
2633
2634   /**
2635    * start a thread to open a URL in the configured browser. Pops up a warning
2636    * dialog to the user if there is an exception when calling out to the browser
2637    * to open the URL.
2638    * 
2639    * @param url
2640    */
2641   public static void showUrl(final String url)
2642   {
2643     showUrl(url, Desktop.instance);
2644   }
2645
2646   /**
2647    * Like showUrl but allows progress handler to be specified
2648    * 
2649    * @param url
2650    * @param progress
2651    *          (null) or object implementing IProgressIndicator
2652    */
2653   public static void showUrl(final String url,
2654           final IProgressIndicator progress)
2655   {
2656     new Thread(new Runnable()
2657     {
2658       public void run()
2659       {
2660         try
2661         {
2662           if (progress != null)
2663           {
2664             progress.setProgressBar(MessageManager.formatMessage("status.opening_params", new String[]{url}), this.hashCode());
2665           }
2666           jalview.util.BrowserLauncher.openURL(url);
2667         } catch (Exception ex)
2668         {
2669           JOptionPane
2670                   .showInternalMessageDialog(
2671                           Desktop.desktop,
2672                           MessageManager.getString("label.web_browser_not_found_unix"),
2673                           MessageManager.getString("label.web_browser_not_found"),
2674                           JOptionPane.WARNING_MESSAGE);
2675
2676           ex.printStackTrace();
2677         }
2678         if (progress != null)
2679         {
2680           progress.setProgressBar(null, this.hashCode());
2681         }
2682       }
2683     }).start();
2684   }
2685
2686   public static WsParamSetManager wsparamManager = null;
2687
2688   public static ParamManager getUserParameterStore()
2689   {
2690     if (wsparamManager == null)
2691     {
2692       wsparamManager = new WsParamSetManager();
2693     }
2694     return wsparamManager;
2695   }
2696
2697   /**
2698    * static hyperlink handler proxy method for use by Jalview's internal windows
2699    * 
2700    * @param e
2701    */
2702   public static void hyperlinkUpdate(HyperlinkEvent e)
2703   {
2704     if (e.getEventType() == EventType.ACTIVATED)
2705     {
2706       String url = null;
2707       try
2708       {
2709         url = e.getURL().toString();
2710         Desktop.showUrl(url);
2711       } catch (Exception x)
2712       {
2713         if (url != null)
2714         {
2715           if (Cache.log != null)
2716           {
2717             Cache.log.error("Couldn't handle string " + url + " as a URL.");
2718           }
2719           else
2720           {
2721             System.err.println("Couldn't handle string " + url
2722                     + " as a URL.");
2723           }
2724         }
2725         // ignore any exceptions due to dud links.
2726       }
2727
2728     }
2729   }
2730
2731   /**
2732    * single thread that handles display of dialogs to user.
2733    */
2734   ExecutorService dialogExecutor = Executors.newSingleThreadExecutor();
2735
2736   /**
2737    * flag indicating if dialogExecutor should try to acquire a permit
2738    */
2739   private volatile boolean dialogPause = true;
2740
2741   /**
2742    * pause the queue
2743    */
2744   private java.util.concurrent.Semaphore block = new Semaphore(0);
2745
2746   /**
2747    * add another dialog thread to the queue
2748    * 
2749    * @param prompter
2750    */
2751   public void addDialogThread(final Runnable prompter)
2752   {
2753     dialogExecutor.submit(new Runnable()
2754     {
2755       public void run()
2756       {
2757         if (dialogPause)
2758         {
2759           try
2760           {
2761             block.acquire();
2762           } catch (InterruptedException x)
2763           {
2764           }
2765           ;
2766         }
2767         if (instance == null)
2768         {
2769           return;
2770         }
2771         try
2772         {
2773           SwingUtilities.invokeAndWait(prompter);
2774         } catch (Exception q)
2775         {
2776           Cache.log.warn("Unexpected Exception in dialog thread.", q);
2777         }
2778       }
2779     });
2780   }
2781
2782   public void startDialogQueue()
2783   {
2784     // set the flag so we don't pause waiting for another permit and semaphore
2785     // the current task to begin
2786     dialogPause = false;
2787     block.release();
2788   }
2789   @Override
2790   protected void snapShotWindow_actionPerformed(ActionEvent e)
2791   {
2792     invalidate();
2793     File of;
2794     ImageMaker im = new jalview.util.ImageMaker(this, ImageMaker.TYPE.EPS,
2795             "View of Desktop", getWidth(), getHeight(), of = new File(
2796                     "Jalview_snapshot" + System.currentTimeMillis()
2797                             + ".eps"), "View of desktop");
2798     try {
2799       paintAll(im.getGraphics());
2800       im.writeImage();
2801     } catch (Exception q)
2802     {
2803       Cache.log.error("Couldn't write snapshot to "+of.getAbsolutePath(),q);
2804       return;
2805     }
2806     Cache.log.info("Successfully written snapshot to file "+of.getAbsolutePath());
2807   }
2808 }