src/jalview/gui/Desktop.java

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