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