src/jalview/gui/Desktop.java

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