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