src/jalview/gui/AppJmol.java

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