src/jalview/gui/AppJmol.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import jalview.bin.Cache;
  24 import jalview.datamodel.Alignment;
  25 import jalview.datamodel.AlignmentI;
  26 import jalview.datamodel.ColumnSelection;
  27 import jalview.datamodel.PDBEntry;
  28 import jalview.datamodel.SequenceI;
  29 import jalview.gui.StructureViewer.ViewerType;
  30 import jalview.io.JalviewFileChooser;
  31 import jalview.io.JalviewFileView;
  32 import jalview.schemes.BuriedColourScheme;
  33 import jalview.schemes.ColourSchemeI;
  34 import jalview.schemes.HelixColourScheme;
  35 import jalview.schemes.HydrophobicColourScheme;
  36 import jalview.schemes.PurinePyrimidineColourScheme;
  37 import jalview.schemes.StrandColourScheme;
  38 import jalview.schemes.TaylorColourScheme;
  39 import jalview.schemes.TurnColourScheme;
  40 import jalview.schemes.ZappoColourScheme;
  41 import jalview.structures.models.AAStructureBindingModel;
  42 import jalview.util.MessageManager;
  43 import jalview.util.Platform;
  44 import jalview.ws.dbsources.Pdb;
  45
  46 import java.awt.BorderLayout;
  47 import java.awt.Color;
  48 import java.awt.Dimension;
  49 import java.awt.Font;
  50 import java.awt.Graphics;
  51 import java.awt.Rectangle;
  52 import java.awt.event.ActionEvent;
  53 import java.awt.event.ItemEvent;
  54 import java.awt.event.ItemListener;
  55 import java.io.BufferedReader;
  56 import java.io.File;
  57 import java.io.FileOutputStream;
  58 import java.io.FileReader;
  59 import java.io.IOException;
  60 import java.io.PrintWriter;
  61 import java.util.ArrayList;
  62 import java.util.List;
  63 import java.util.Vector;
  64
  65 import javax.swing.JCheckBoxMenuItem;
  66 import javax.swing.JColorChooser;
  67 import javax.swing.JInternalFrame;
  68 import javax.swing.JMenu;
  69 import javax.swing.JOptionPane;
  70 import javax.swing.JPanel;
  71 import javax.swing.JSplitPane;
  72 import javax.swing.SwingUtilities;
  73 import javax.swing.event.InternalFrameAdapter;
  74 import javax.swing.event.InternalFrameEvent;
  75 import javax.swing.event.MenuEvent;
  76 import javax.swing.event.MenuListener;
  77
  78 public class AppJmol extends StructureViewerBase
  79 {
  80   // ms to wait for Jmol to load files
  81   private static final int JMOL_LOAD_TIMEOUT = 20000;
  82
  83   private static final String SPACE = " ";
  84
  85   private static final String BACKSLASH = "\"";
  86
  87   AppJmolBinding jmb;
  88
  89   JPanel scriptWindow;
  90
  91   JSplitPane splitPane;
  92
  93   RenderPanel renderPanel;
  94
  95   ViewSelectionMenu seqColourBy;
  96
  97   /**
  98    *
  99    * @param files
 100    * @param ids
 101    * @param seqs
 102    * @param ap
 103    * @param usetoColour
 104    *          - add the alignment panel to the list used for colouring these
 105    *          structures
 106    * @param useToAlign
 107    *          - add the alignment panel to the list used for aligning these
 108    *          structures
 109    * @param leaveColouringToJmol
 110    *          - do not update the colours from any other source. Jmol is
 111    *          handling them
 112    * @param loadStatus
 113    * @param bounds
 114    * @param viewid
 115    */
 116   public AppJmol(String[] files, String[] ids, SequenceI[][] seqs,
 117           AlignmentPanel ap, boolean usetoColour, boolean useToAlign,
 118           boolean leaveColouringToJmol, String loadStatus,
 119           Rectangle bounds, String viewid)
 120   {
 121     PDBEntry[] pdbentrys = new PDBEntry[files.length];
 122     for (int i = 0; i < pdbentrys.length; i++)
 123     {
 124       // PDBEntry pdbentry = new PDBEntry(files[i], ids[i]);
 125       PDBEntry pdbentry = new PDBEntry(ids[i], null, PDBEntry.Type.PDB,
 126               files[i]);
 127       pdbentrys[i] = pdbentry;
 128     }
 129     // / TODO: check if protocol is needed to be set, and if chains are
 130     // autodiscovered.
 131     jmb = new AppJmolBinding(this, ap.getStructureSelectionManager(),
 132             pdbentrys, seqs, null);
 133
 134     jmb.setLoadingFromArchive(true);
 135     addAlignmentPanel(ap);
 136     if (useToAlign)
 137     {
 138       useAlignmentPanelForSuperposition(ap);
 139     }
 140     if (leaveColouringToJmol || !usetoColour)
 141     {
 142       jmb.setColourBySequence(false);
 143       seqColour.setSelected(false);
 144       viewerColour.setSelected(true);
 145     }
 146     else if (usetoColour)
 147     {
 148       useAlignmentPanelForColourbyseq(ap);
 149       jmb.setColourBySequence(true);
 150       seqColour.setSelected(true);
 151       viewerColour.setSelected(false);
 152     }
 153     this.setBounds(bounds);
 154     initMenus();
 155     setViewId(viewid);
 156     // jalview.gui.Desktop.addInternalFrame(this, "Loading File",
 157     // bounds.width,bounds.height);
 158
 159     this.addInternalFrameListener(new InternalFrameAdapter()
 160     {
 161       @Override
 162       public void internalFrameClosing(InternalFrameEvent internalFrameEvent)
 163       {
 164         closeViewer(false);
 165       }
 166     });
 167     initJmol(loadStatus); // pdbentry, seq, JBPCHECK!
 168
 169   }
 170
 171   private void initMenus()
 172   {
 173     seqColour.setSelected(jmb.isColourBySequence());
 174     viewerColour.setSelected(!jmb.isColourBySequence());
 175     if (_colourwith == null)
 176     {
 177       _colourwith = new Vector<AlignmentPanel>();
 178     }
 179     if (_alignwith == null)
 180     {
 181       _alignwith = new Vector<AlignmentPanel>();
 182     }
 183
 184     seqColourBy = new ViewSelectionMenu(
 185             MessageManager.getString("label.colour_by"), this, _colourwith,
 186             new ItemListener()
 187             {
 188
 189               @Override
 190               public void itemStateChanged(ItemEvent e)
 191               {
 192                 if (!seqColour.isSelected())
 193                 {
 194                   seqColour.doClick();
 195                 }
 196                 else
 197                 {
 198                   // update the jmol display now.
 199                   seqColour_actionPerformed(null);
 200                 }
 201               }
 202             });
 203     viewMenu.add(seqColourBy);
 204     final ItemListener handler;
 205     JMenu alpanels = new ViewSelectionMenu(
 206             MessageManager.getString("label.superpose_with"), this,
 207             _alignwith, handler = new ItemListener()
 208             {
 209
 210               @Override
 211               public void itemStateChanged(ItemEvent e)
 212               {
 213                 alignStructs.setEnabled(_alignwith.size() > 0);
 214                 alignStructs.setToolTipText(MessageManager
 215                         .formatMessage(
 216                                 "label.align_structures_using_linked_alignment_views",
 217                                 new String[] { new Integer(_alignwith
 218                                         .size()).toString() }));
 219               }
 220             });
 221     handler.itemStateChanged(null);
 222     viewerActionMenu.add(alpanels);
 223     viewerActionMenu.addMenuListener(new MenuListener()
 224     {
 225
 226       @Override
 227       public void menuSelected(MenuEvent e)
 228       {
 229         handler.itemStateChanged(null);
 230       }
 231
 232       @Override
 233       public void menuDeselected(MenuEvent e)
 234       {
 235         // TODO Auto-generated method stub
 236
 237       }
 238
 239       @Override
 240       public void menuCanceled(MenuEvent e)
 241       {
 242         // TODO Auto-generated method stub
 243
 244       }
 245     });
 246   }
 247
 248   IProgressIndicator progressBar = null;
 249
 250   @Override
 251   protected IProgressIndicator getIProgressIndicator()
 252   {
 253     return progressBar;
 254   }
 255   /**
 256    * add a single PDB structure to a new or existing Jmol view
 257    *
 258    * @param pdbentry
 259    * @param seq
 260    * @param chains
 261    * @param ap
 262    */
 263   public AppJmol(PDBEntry pdbentry, SequenceI[] seq, String[] chains,
 264           final AlignmentPanel ap)
 265   {
 266     progressBar = ap.alignFrame;
 267     String pdbId = pdbentry.getId();
 268
 269     /*
 270      * If the PDB file is already loaded, the user may just choose to add to an
 271      * existing viewer (or cancel)
 272      */
 273     if (addAlreadyLoadedFile(seq, chains, ap, pdbId))
 274     {
 275       return;
 276     }
 277
 278     /*
 279      * Check if there are other Jmol views involving this alignment and prompt
 280      * user about adding this molecule to one of them
 281      */
 282     if (addToExistingViewer(pdbentry, seq, chains, ap, pdbId))
 283     {
 284       return;
 285     }
 286
 287     /*
 288      * If the options above are declined or do not apply, open a new viewer
 289      */
 290     openNewJmol(ap, new PDBEntry[] { pdbentry }, new SequenceI[][] { seq });
 291   }
 292
 293   /**
 294    * Answers true if this viewer already involves the given PDB ID
 295    */
 296   @Override
 297   protected boolean hasPdbId(String pdbId)
 298   {
 299     return jmb.hasPdbId(pdbId);
 300   }
 301
 302   private void openNewJmol(AlignmentPanel ap, PDBEntry[] pdbentrys,
 303           SequenceI[][] seqs)
 304   {
 305     progressBar = ap.alignFrame;
 306     jmb = new AppJmolBinding(this, ap.getStructureSelectionManager(),
 307             pdbentrys, seqs, null);
 308     addAlignmentPanel(ap);
 309     useAlignmentPanelForColourbyseq(ap);
 310     if (pdbentrys.length > 1)
 311     {
 312       alignAddedStructures = true;
 313       useAlignmentPanelForSuperposition(ap);
 314     }
 315     jmb.setColourBySequence(true);
 316     setSize(400, 400); // probably should be a configurable/dynamic default here
 317     initMenus();
 318     addingStructures = false;
 319     worker = new Thread(this);
 320     worker.start();
 321
 322     this.addInternalFrameListener(new InternalFrameAdapter()
 323     {
 324       @Override
 325       public void internalFrameClosing(InternalFrameEvent internalFrameEvent)
 326       {
 327         closeViewer(false);
 328       }
 329     });
 330
 331   }
 332
 333   /**
 334    * create a new Jmol containing several structures superimposed using the
 335    * given alignPanel.
 336    *
 337    * @param ap
 338    * @param pe
 339    * @param seqs
 340    */
 341   public AppJmol(AlignmentPanel ap, PDBEntry[] pe, SequenceI[][] seqs)
 342   {
 343     openNewJmol(ap, pe, seqs);
 344   }
 345
 346   /**
 347    * Returns a list of any Jmol viewers. The list is restricted to those linked
 348    * to the given alignment panel if it is not null.
 349    */
 350   @Override
 351   protected List<StructureViewerBase> getViewersFor(AlignmentPanel apanel)
 352   {
 353     List<StructureViewerBase> result = new ArrayList<StructureViewerBase>();
 354     JInternalFrame[] frames = Desktop.instance.getAllFrames();
 355
 356     for (JInternalFrame frame : frames)
 357     {
 358       if (frame instanceof AppJmol)
 359       {
 360         if (apanel == null
 361                 || ((StructureViewerBase) frame).isLinkedWith(apanel))
 362         {
 363           result.add((StructureViewerBase) frame);
 364         }
 365       }
 366     }
 367     return result;
 368   }
 369
 370   void initJmol(String command)
 371   {
 372     jmb.setFinishedInit(false);
 373     renderPanel = new RenderPanel();
 374     // TODO: consider waiting until the structure/view is fully loaded before
 375     // displaying
 376     this.getContentPane().add(renderPanel, java.awt.BorderLayout.CENTER);
 377     jalview.gui.Desktop.addInternalFrame(this, jmb.getViewerTitle(),
 378             getBounds().width, getBounds().height);
 379     if (scriptWindow == null)
 380     {
 381       BorderLayout bl = new BorderLayout();
 382       bl.setHgap(0);
 383       bl.setVgap(0);
 384       scriptWindow = new JPanel(bl);
 385       scriptWindow.setVisible(false);
 386     }
 387
 388     jmb.allocateViewer(renderPanel, true, "", null, null, "",
 389             scriptWindow, null);
 390     // jmb.newJmolPopup("Jmol");
 391     if (command == null)
 392     {
 393       command = "";
 394     }
 395     jmb.evalStateCommand(command);
 396     jmb.evalStateCommand("set hoverDelay=0.1");
 397     jmb.setFinishedInit(true);
 398   }
 399
 400
 401
 402   boolean allChainsSelected = false;
 403
 404   @Override
 405   void showSelectedChains()
 406   {
 407     Vector<String> toshow = new Vector<String>();
 408     for (int i = 0; i < chainMenu.getItemCount(); i++)
 409     {
 410       if (chainMenu.getItem(i) instanceof JCheckBoxMenuItem)
 411       {
 412         JCheckBoxMenuItem item = (JCheckBoxMenuItem) chainMenu.getItem(i);
 413         if (item.isSelected())
 414         {
 415           toshow.addElement(item.getText());
 416         }
 417       }
 418     }
 419     jmb.centerViewer(toshow);
 420   }
 421
 422   @Override
 423   public void closeViewer(boolean closeExternalViewer)
 424   {
 425     // Jmol does not use an external viewer
 426     if (jmb != null)
 427     {
 428       jmb.closeViewer();
 429     }
 430     setAlignmentPanel(null);
 431     _aps.clear();
 432     _alignwith.clear();
 433     _colourwith.clear();
 434     // TODO: check for memory leaks where instance isn't finalised because jmb
 435     // holds a reference to the window
 436     jmb = null;
 437   }
 438
 439   @Override
 440   public void run()
 441   {
 442     _started = true;
 443     try
 444     {
 445       List<String> files = fetchPdbFiles();
 446       if (files.size() > 0)
 447       {
 448         showFilesInViewer(files);
 449       }
 450     } finally
 451     {
 452       _started = false;
 453       worker = null;
 454     }
 455   }
 456
 457   /**
 458    * Either adds the given files to a structure viewer or opens a new viewer to
 459    * show them
 460    *
 461    * @param files
 462    *          list of absolute paths to structure files
 463    */
 464   void showFilesInViewer(List<String> files)
 465   {
 466     long lastnotify = jmb.getLoadNotifiesHandled();
 467     StringBuilder fileList = new StringBuilder();
 468     for (String s : files)
 469     {
 470       fileList.append(SPACE).append(BACKSLASH)
 471               .append(Platform.escapeString(s)).append(BACKSLASH);
 472     }
 473     String filesString = fileList.toString();
 474
 475     if (!addingStructures)
 476     {
 477       try
 478       {
 479         initJmol("load FILES " + filesString);
 480       } catch (OutOfMemoryError oomerror)
 481       {
 482         new OOMWarning("When trying to open the Jmol viewer!", oomerror);
 483         Cache.log.debug("File locations are " + filesString);
 484       } catch (Exception ex)
 485       {
 486         Cache.log.error("Couldn't open Jmol viewer!", ex);
 487       }
 488     }
 489     else
 490     {
 491       StringBuilder cmd = new StringBuilder();
 492       cmd.append("loadingJalviewdata=true\nload APPEND ");
 493       cmd.append(filesString);
 494       cmd.append("\nloadingJalviewdata=null");
 495       final String command = cmd.toString();
 496       lastnotify = jmb.getLoadNotifiesHandled();
 497
 498       try
 499       {
 500         jmb.evalStateCommand(command);
 501       } catch (OutOfMemoryError oomerror)
 502       {
 503         new OOMWarning("When trying to add structures to the Jmol viewer!",
 504                 oomerror);
 505         Cache.log.debug("File locations are " + filesString);
 506       } catch (Exception ex)
 507       {
 508         Cache.log.error("Couldn't add files to Jmol viewer!", ex);
 509       }
 510     }
 511
 512     // need to wait around until script has finished
 513     int waitMax = JMOL_LOAD_TIMEOUT;
 514     int waitFor = 35;
 515     int waitTotal = 0;
 516     while (addingStructures ? lastnotify >= jmb.getLoadNotifiesHandled()
 517             : !(jmb.isFinishedInit() && jmb.getPdbFile() != null && jmb
 518                     .getPdbFile().length == files.size()))
 519     {
 520       try
 521       {
 522         Cache.log.debug("Waiting around for jmb notify.");
 523         Thread.sleep(waitFor);
 524         waitTotal += waitFor;
 525       } catch (Exception e)
 526       {
 527       }
 528       if (waitTotal > waitMax)
 529       {
 530         System.err
 531                 .println("Timed out waiting for Jmol to load files after "
 532                         + waitTotal + "ms");
 533 //        System.err.println("finished: " + jmb.isFinishedInit()
 534 //                + "; loaded: " + Arrays.toString(jmb.getPdbFile())
 535 //                + "; files: " + files.toString());
 536         jmb.getPdbFile();
 537         break;
 538       }
 539     }
 540
 541     // refresh the sequence colours for the new structure(s)
 542     for (AlignmentPanel ap : _colourwith)
 543     {
 544       jmb.updateColours(ap);
 545     }
 546     // do superposition if asked to
 547     if (Cache.getDefault("AUTOSUPERIMPOSE", true) && alignAddedStructures)
 548     {
 549       alignAddedStructures();
 550     }
 551     addingStructures = false;
 552   }
 553
 554   /**
 555    * Queues a thread to align structures with Jalview alignments
 556    */
 557   void alignAddedStructures()
 558   {
 559     javax.swing.SwingUtilities.invokeLater(new Runnable()
 560     {
 561       @Override
 562       public void run()
 563       {
 564         if (jmb.viewer.isScriptExecuting())
 565         {
 566           SwingUtilities.invokeLater(this);
 567           try
 568           {
 569             Thread.sleep(5);
 570           } catch (InterruptedException q)
 571           {
 572           }
 573           return;
 574         }
 575         else
 576         {
 577           alignStructs_withAllAlignPanels();
 578         }
 579       }
 580     });
 581     alignAddedStructures = false;
 582   }
 583
 584   /**
 585    * Retrieves and saves as file any modelled PDB entries for which we do not
 586    * already have a file saved. Returns a list of absolute paths to structure
 587    * files which were either retrieved, or already stored but not modelled in
 588    * the structure viewer (i.e. files to add to the viewer display).
 589    *
 590    * @return
 591    */
 592   List<String> fetchPdbFiles()
 593   {
 594     // todo - record which pdbids were successfully imported.
 595     StringBuilder errormsgs = new StringBuilder();
 596
 597     List<String> files = new ArrayList<String>();
 598     String pdbid = "";
 599     try
 600     {
 601       String[] filesInViewer = jmb.getPdbFile();
 602       // TODO: replace with reference fetching/transfer code (validate PDBentry
 603       // as a DBRef?)
 604       Pdb pdbclient = new Pdb();
 605       for (int pi = 0; pi < jmb.getPdbCount(); pi++)
 606       {
 607         String file = jmb.getPdbEntry(pi).getFile();
 608         if (file == null)
 609         {
 610           // retrieve the pdb and store it locally
 611           AlignmentI pdbseq = null;
 612           pdbid = jmb.getPdbEntry(pi).getId();
 613           long hdl = pdbid.hashCode() - System.currentTimeMillis();
 614           if (progressBar != null)
 615           {
 616             progressBar.setProgressBar(MessageManager.formatMessage(
 617                     "status.fetching_pdb", new String[] { pdbid }), hdl);
 618           }
 619           try
 620           {
 621             pdbseq = pdbclient.getSequenceRecords(pdbid);
 622           } catch (OutOfMemoryError oomerror)
 623           {
 624             new OOMWarning("Retrieving PDB id " + pdbid, oomerror);
 625           } catch (Exception ex)
 626           {
 627             ex.printStackTrace();
 628             errormsgs.append("'").append(pdbid).append("'");
 629           } finally
 630           {
 631             if (progressBar != null)
 632             {
 633               progressBar.setProgressBar(
 634                       MessageManager.getString("label.state_completed"),
 635                       hdl);
 636             }
 637           }
 638           if (pdbseq != null)
 639           {
 640             // just transfer the file name from the first sequence's first
 641             // PDBEntry
 642             file = new File(pdbseq.getSequenceAt(0).getAllPDBEntries()
 643                     .elementAt(0).getFile()).getAbsolutePath();
 644             jmb.getPdbEntry(pi).setFile(file);
 645             files.add(file);
 646           }
 647           else
 648           {
 649             errormsgs.append("'").append(pdbid).append("' ");
 650           }
 651         }
 652         else
 653         {
 654           if (filesInViewer != null && filesInViewer.length > 0)
 655           {
 656             addingStructures = true; // already files loaded.
 657             for (int c = 0; c < filesInViewer.length; c++)
 658             {
 659               if (filesInViewer[c].equals(file))
 660               {
 661                 file = null;
 662                 break;
 663               }
 664             }
 665           }
 666           if (file != null)
 667           {
 668             files.add(file);
 669           }
 670         }
 671       }
 672     } catch (OutOfMemoryError oomerror)
 673     {
 674       new OOMWarning("Retrieving PDB files: " + pdbid, oomerror);
 675     } catch (Exception ex)
 676     {
 677       ex.printStackTrace();
 678       errormsgs.append("When retrieving pdbfiles : current was: '")
 679               .append(pdbid).append("'");
 680     }
 681     if (errormsgs.length() > 0)
 682     {
 683       JvOptionPane.showInternalMessageDialog(Desktop.desktop, MessageManager
 684               .formatMessage("label.pdb_entries_couldnt_be_retrieved",
 685                       new String[] { errormsgs.toString() }),
 686               MessageManager.getString("label.couldnt_load_file"),
 687               JvOptionPane.ERROR_MESSAGE);
 688     }
 689     return files;
 690   }
 691
 692   @Override
 693   public void pdbFile_actionPerformed(ActionEvent actionEvent)
 694   {
 695     JalviewFileChooser chooser = new JalviewFileChooser(
 696             jalview.bin.Cache.getProperty("LAST_DIRECTORY"));
 697
 698     chooser.setFileView(new JalviewFileView());
 699     chooser.setDialogTitle(MessageManager.getString("label.save_pdb_file"));
 700     chooser.setToolTipText(MessageManager.getString("action.save"));
 701
 702     int value = chooser.showSaveDialog(this);
 703
 704     if (value == JalviewFileChooser.APPROVE_OPTION)
 705     {
 706       BufferedReader in = null;
 707       try
 708       {
 709         // TODO: cope with multiple PDB files in view
 710         in = new BufferedReader(new FileReader(jmb.getPdbFile()[0]));
 711         File outFile = chooser.getSelectedFile();
 712
 713         PrintWriter out = new PrintWriter(new FileOutputStream(outFile));
 714         String data;
 715         while ((data = in.readLine()) != null)
 716         {
 717           if (!(data.indexOf("<PRE>") > -1 || data.indexOf("</PRE>") > -1))
 718           {
 719             out.println(data);
 720           }
 721         }
 722         out.close();
 723       } catch (Exception ex)
 724       {
 725         ex.printStackTrace();
 726       } finally
 727       {
 728         if (in != null)
 729         {
 730           try
 731           {
 732             in.close();
 733           } catch (IOException e)
 734           {
 735             // ignore
 736           }
 737         }
 738       }
 739     }
 740   }
 741
 742   @Override
 743   public void viewMapping_actionPerformed(ActionEvent actionEvent)
 744   {
 745     jalview.gui.CutAndPasteTransfer cap = new jalview.gui.CutAndPasteTransfer();
 746     try
 747     {
 748       cap.appendText(jmb.printMappings());
 749     } catch (OutOfMemoryError e)
 750     {
 751       new OOMWarning(
 752               "composing sequence-structure alignments for display in text box.",
 753               e);
 754       cap.dispose();
 755       return;
 756     }
 757     jalview.gui.Desktop.addInternalFrame(cap,
 758             MessageManager.getString("label.pdb_sequence_mapping"), 550,
 759             600);
 760   }
 761
 762   @Override
 763   public void eps_actionPerformed(ActionEvent e)
 764   {
 765     makePDBImage(jalview.util.ImageMaker.TYPE.EPS);
 766   }
 767
 768   @Override
 769   public void png_actionPerformed(ActionEvent e)
 770   {
 771     makePDBImage(jalview.util.ImageMaker.TYPE.PNG);
 772   }
 773
 774   void makePDBImage(jalview.util.ImageMaker.TYPE type)
 775   {
 776     int width = getWidth();
 777     int height = getHeight();
 778
 779     jalview.util.ImageMaker im;
 780
 781     if (type == jalview.util.ImageMaker.TYPE.PNG)
 782     {
 783       im = new jalview.util.ImageMaker(this,
 784               jalview.util.ImageMaker.TYPE.PNG, "Make PNG image from view",
 785               width, height, null, null, null, 0, false);
 786     }
 787     else if (type == jalview.util.ImageMaker.TYPE.EPS)
 788     {
 789       im = new jalview.util.ImageMaker(this,
 790               jalview.util.ImageMaker.TYPE.EPS, "Make EPS file from view",
 791               width, height, null, this.getTitle(), null, 0, false);
 792     }
 793     else
 794     {
 795
 796       im = new jalview.util.ImageMaker(this,
 797               jalview.util.ImageMaker.TYPE.SVG, "Make SVG file from PCA",
 798               width, height, null, this.getTitle(), null, 0, false);
 799     }
 800
 801     if (im.getGraphics() != null)
 802     {
 803       jmb.viewer.renderScreenImage(im.getGraphics(), width, height);
 804       im.writeImage();
 805     }
 806   }
 807
 808   @Override
 809   public void viewerColour_actionPerformed(ActionEvent actionEvent)
 810   {
 811     if (viewerColour.isSelected())
 812     {
 813       // disable automatic sequence colouring.
 814       jmb.setColourBySequence(false);
 815     }
 816   }
 817
 818   @Override
 819   public void seqColour_actionPerformed(ActionEvent actionEvent)
 820   {
 821     jmb.setColourBySequence(seqColour.isSelected());
 822     if (_colourwith == null)
 823     {
 824       _colourwith = new Vector<AlignmentPanel>();
 825     }
 826     if (jmb.isColourBySequence())
 827     {
 828       if (!jmb.isLoadingFromArchive())
 829       {
 830         if (_colourwith.size() == 0 && getAlignmentPanel() != null)
 831         {
 832           // Make the currently displayed alignment panel the associated view
 833           _colourwith.add(getAlignmentPanel().alignFrame.alignPanel);
 834         }
 835       }
 836       // Set the colour using the current view for the associated alignframe
 837       for (AlignmentPanel ap : _colourwith)
 838       {
 839         jmb.colourBySequence(ap);
 840       }
 841     }
 842   }
 843
 844   @Override
 845   public void chainColour_actionPerformed(ActionEvent actionEvent)
 846   {
 847     chainColour.setSelected(true);
 848     jmb.colourByChain();
 849   }
 850
 851   @Override
 852   public void chargeColour_actionPerformed(ActionEvent actionEvent)
 853   {
 854     chargeColour.setSelected(true);
 855     jmb.colourByCharge();
 856   }
 857
 858   @Override
 859   public void zappoColour_actionPerformed(ActionEvent actionEvent)
 860   {
 861     zappoColour.setSelected(true);
 862     jmb.setJalviewColourScheme(new ZappoColourScheme());
 863   }
 864
 865   @Override
 866   public void taylorColour_actionPerformed(ActionEvent actionEvent)
 867   {
 868     taylorColour.setSelected(true);
 869     jmb.setJalviewColourScheme(new TaylorColourScheme());
 870   }
 871
 872   @Override
 873   public void hydroColour_actionPerformed(ActionEvent actionEvent)
 874   {
 875     hydroColour.setSelected(true);
 876     jmb.setJalviewColourScheme(new HydrophobicColourScheme());
 877   }
 878
 879   @Override
 880   public void helixColour_actionPerformed(ActionEvent actionEvent)
 881   {
 882     helixColour.setSelected(true);
 883     jmb.setJalviewColourScheme(new HelixColourScheme());
 884   }
 885
 886   @Override
 887   public void strandColour_actionPerformed(ActionEvent actionEvent)
 888   {
 889     strandColour.setSelected(true);
 890     jmb.setJalviewColourScheme(new StrandColourScheme());
 891   }
 892
 893   @Override
 894   public void turnColour_actionPerformed(ActionEvent actionEvent)
 895   {
 896     turnColour.setSelected(true);
 897     jmb.setJalviewColourScheme(new TurnColourScheme());
 898   }
 899
 900   @Override
 901   public void buriedColour_actionPerformed(ActionEvent actionEvent)
 902   {
 903     buriedColour.setSelected(true);
 904     jmb.setJalviewColourScheme(new BuriedColourScheme());
 905   }
 906
 907   @Override
 908   public void purinePyrimidineColour_actionPerformed(ActionEvent actionEvent)
 909   {
 910     setJalviewColourScheme(new PurinePyrimidineColourScheme());
 911   }
 912
 913   @Override
 914   public void userColour_actionPerformed(ActionEvent actionEvent)
 915   {
 916     userColour.setSelected(true);
 917     new UserDefinedColours(this, null);
 918   }
 919
 920   @Override
 921   public void backGround_actionPerformed(ActionEvent actionEvent)
 922   {
 923     java.awt.Color col = JColorChooser
 924             .showDialog(this, MessageManager
 925                     .getString("label.select_backgroud_colour"), null);
 926     if (col != null)
 927     {
 928       jmb.setBackgroundColour(col);
 929     }
 930   }
 931
 932   @Override
 933   public void showHelp_actionPerformed(ActionEvent actionEvent)
 934   {
 935     try
 936     {
 937       jalview.util.BrowserLauncher
 938               .openURL("http://jmol.sourceforge.net/docs/JmolUserGuide/");
 939     } catch (Exception ex)
 940     {
 941     }
 942   }
 943
 944   public void showConsole(boolean showConsole)
 945   {
 946
 947     if (showConsole)
 948     {
 949       if (splitPane == null)
 950       {
 951         splitPane = new JSplitPane(JSplitPane.VERTICAL_SPLIT);
 952         splitPane.setTopComponent(renderPanel);
 953         splitPane.setBottomComponent(scriptWindow);
 954         this.getContentPane().add(splitPane, BorderLayout.CENTER);
 955         splitPane.setDividerLocation(getHeight() - 200);
 956         scriptWindow.setVisible(true);
 957         scriptWindow.validate();
 958         splitPane.validate();
 959       }
 960
 961     }
 962     else
 963     {
 964       if (splitPane != null)
 965       {
 966         splitPane.setVisible(false);
 967       }
 968
 969       splitPane = null;
 970
 971       this.getContentPane().add(renderPanel, BorderLayout.CENTER);
 972     }
 973
 974     validate();
 975   }
 976
 977   class RenderPanel extends JPanel
 978   {
 979     final Dimension currentSize = new Dimension();
 980
 981     @Override
 982     public void paintComponent(Graphics g)
 983     {
 984       getSize(currentSize);
 985
 986       if (jmb != null && jmb.fileLoadingError != null)
 987       {
 988         g.setColor(Color.black);
 989         g.fillRect(0, 0, currentSize.width, currentSize.height);
 990         g.setColor(Color.white);
 991         g.setFont(new Font("Verdana", Font.BOLD, 14));
 992         g.drawString(MessageManager.getString("label.error_loading_file")
 993                 + "...", 20, currentSize.height / 2);
 994         StringBuffer sb = new StringBuffer();
 995         int lines = 0;
 996         for (int e = 0; e < jmb.getPdbCount(); e++)
 997         {
 998           sb.append(jmb.getPdbEntry(e).getId());
 999           if (e < jmb.getPdbCount() - 1)
1000           {
1001             sb.append(",");
1002           }
1003
1004           if (e == jmb.getPdbCount() - 1 || sb.length() > 20)
1005           {
1006             lines++;
1007             g.drawString(sb.toString(), 20, currentSize.height / 2 - lines
1008                     * g.getFontMetrics().getHeight());
1009           }
1010         }
1011       }
1012       else if (jmb == null || jmb.viewer == null || !jmb.isFinishedInit())
1013       {
1014         g.setColor(Color.black);
1015         g.fillRect(0, 0, currentSize.width, currentSize.height);
1016         g.setColor(Color.white);
1017         g.setFont(new Font("Verdana", Font.BOLD, 14));
1018         g.drawString(MessageManager.getString("label.retrieving_pdb_data"),
1019                 20, currentSize.height / 2);
1020       }
1021       else
1022       {
1023         jmb.viewer.renderScreenImage(g, currentSize.width,
1024                 currentSize.height);
1025       }
1026     }
1027   }
1028
1029   public void updateTitleAndMenus()
1030   {
1031     if (jmb.fileLoadingError != null && jmb.fileLoadingError.length() > 0)
1032     {
1033       repaint();
1034       return;
1035     }
1036     setChainMenuItems(jmb.getChainNames());
1037
1038     this.setTitle(jmb.getViewerTitle());
1039     if (jmb.getPdbFile().length > 1 && jmb.getSequence().length > 1)
1040     {
1041       viewerActionMenu.setVisible(true);
1042     }
1043     if (!jmb.isLoadingFromArchive())
1044     {
1045       seqColour_actionPerformed(null);
1046     }
1047   }
1048
1049   /*
1050    * (non-Javadoc)
1051    *
1052    * @see
1053    * jalview.jbgui.GStructureViewer#alignStructs_actionPerformed(java.awt.event
1054    * .ActionEvent)
1055    */
1056   @Override
1057   protected void alignStructs_actionPerformed(ActionEvent actionEvent)
1058   {
1059     alignStructs_withAllAlignPanels();
1060   }
1061
1062   private void alignStructs_withAllAlignPanels()
1063   {
1064     if (getAlignmentPanel() == null)
1065     {
1066       return;
1067     }
1068     ;
1069     if (_alignwith.size() == 0)
1070     {
1071       _alignwith.add(getAlignmentPanel());
1072     }
1073     ;
1074     try
1075     {
1076       AlignmentI[] als = new Alignment[_alignwith.size()];
1077       ColumnSelection[] alc = new ColumnSelection[_alignwith.size()];
1078       int[] alm = new int[_alignwith.size()];
1079       int a = 0;
1080
1081       for (AlignmentPanel ap : _alignwith)
1082       {
1083         als[a] = ap.av.getAlignment();
1084         alm[a] = -1;
1085         alc[a++] = ap.av.getColumnSelection();
1086       }
1087       jmb.superposeStructures(als, alm, alc);
1088     } catch (Exception e)
1089     {
1090       StringBuffer sp = new StringBuffer();
1091       for (AlignmentPanel ap : _alignwith)
1092       {
1093         sp.append("'" + ap.alignFrame.getTitle() + "' ");
1094       }
1095       Cache.log.info("Couldn't align structures with the " + sp.toString()
1096               + "associated alignment panels.", e);
1097
1098     }
1099
1100   }
1101
1102   @Override
1103   public void setJalviewColourScheme(ColourSchemeI ucs)
1104   {
1105     jmb.setJalviewColourScheme(ucs);
1106
1107   }
1108
1109   /**
1110    *
1111    * @param alignment
1112    * @return first alignment panel displaying given alignment, or the default
1113    *         alignment panel
1114    */
1115   public AlignmentPanel getAlignmentPanelFor(AlignmentI alignment)
1116   {
1117     for (AlignmentPanel ap : getAllAlignmentPanels())
1118     {
1119       if (ap.av.getAlignment() == alignment)
1120       {
1121         return ap;
1122       }
1123     }
1124     return getAlignmentPanel();
1125   }
1126
1127   @Override
1128   public AAStructureBindingModel getBinding()
1129   {
1130     return this.jmb;
1131   }
1132
1133   @Override
1134   public String getStateInfo()
1135   {
1136     return jmb == null ? null : jmb.viewer.getStateInfo();
1137   }
1138
1139   @Override
1140   public ViewerType getViewerType()
1141   {
1142     return ViewerType.JMOL;
1143   }
1144
1145   @Override
1146   protected AAStructureBindingModel getBindingModel()
1147   {
1148     return jmb;
1149   }
1150
1151 }