src/jalview/gui/AppJmol.java

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