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