src/jalview/gui/Desktop.java

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