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