src/jalview/gui/Desktop.java

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