src/jalview/gui/Desktop.java

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