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