src/jalview/gui/Desktop.java

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