src/jalview/appletgui/AppletJmol.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
   3  * Copyright (C) 2014 The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3 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  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18  */
  19 package jalview.appletgui;
  20
  21 import java.util.*;
  22 import java.awt.*;
  23 import java.awt.event.*;
  24
  25 import jalview.api.SequenceStructureBinding;
  26 import jalview.datamodel.*;
  27 import jalview.structure.*;
  28 import jalview.io.*;
  29
  30 import jalview.schemes.*;
  31
  32 public class AppletJmol extends EmbmenuFrame implements
  33 // StructureListener,
  34         KeyListener, ActionListener, ItemListener, SequenceStructureBinding
  35
  36 {
  37   Menu fileMenu = new Menu("File");
  38
  39   Menu viewMenu = new Menu("View");
  40
  41   Menu coloursMenu = new Menu("Colours");
  42
  43   Menu chainMenu = new Menu("Show Chain");
  44
  45   Menu helpMenu = new Menu("Help");
  46
  47   MenuItem mappingMenuItem = new MenuItem("View Mapping");
  48
  49   CheckboxMenuItem seqColour = new CheckboxMenuItem("By Sequence", true);
  50
  51   CheckboxMenuItem jmolColour = new CheckboxMenuItem("Using Jmol", false);
  52
  53   MenuItem chain = new MenuItem("By Chain");
  54
  55   MenuItem charge = new MenuItem("Charge & Cysteine");
  56
  57   MenuItem zappo = new MenuItem("Zappo");
  58
  59   MenuItem taylor = new MenuItem("Taylor");
  60
  61   MenuItem hydro = new MenuItem("Hydrophobicity");
  62
  63   MenuItem helix = new MenuItem("Helix Propensity");
  64
  65   MenuItem strand = new MenuItem("Strand Propensity");
  66
  67   MenuItem turn = new MenuItem("Turn Propensity");
  68
  69   MenuItem buried = new MenuItem("Buried Index");
  70
  71   MenuItem purinepyrimidine = new MenuItem("Purine/Pyrimidine");
  72
  73   MenuItem user = new MenuItem("User Defined Colours");
  74
  75   MenuItem jmolHelp = new MenuItem("Jmol Help");
  76
  77   Panel scriptWindow;
  78
  79   TextField inputLine;
  80
  81   TextArea history;
  82
  83   RenderPanel renderPanel;
  84
  85   AlignmentPanel ap;
  86
  87   ArrayList _aps = new ArrayList();
  88
  89   String fileLoadingError;
  90
  91   boolean loadedInline;
  92
  93   // boolean colourBySequence = true;
  94
  95   FeatureRenderer fr = null;
  96
  97   AppletJmolBinding jmb;
  98
  99   /**
 100    * datasource protocol for access to PDBEntry
 101    */
 102   String protocol = null;
 103
 104   /**
 105    * Load a bunch of pdb entries associated with sequences in the alignment and
 106    * display them - aligning them if necessary.
 107    *
 108    * @param pdbentries
 109    *          each pdb file (at least one needed)
 110    * @param boundseqs
 111    *          each set of sequences for each pdb file (must match number of pdb
 112    *          files)
 113    * @param boundchains
 114    *          the target pdb chain corresponding with each sequence associated
 115    *          with each pdb file (may be null at any level)
 116    * @param align
 117    *          true/false
 118    * @param ap
 119    *          associated alignment
 120    * @param protocol
 121    *          how to get pdb data
 122    */
 123   public AppletJmol(PDBEntry[] pdbentries, SequenceI[][] boundseqs,
 124           String[][] boundchains, boolean align, AlignmentPanel ap,
 125           String protocol)
 126   {
 127     throw new Error("Not yet implemented.");
 128   }
 129
 130   public AppletJmol(PDBEntry pdbentry, SequenceI[] seq, String[] chains,
 131           AlignmentPanel ap, String protocol)
 132   {
 133     this.ap = ap;
 134     jmb = new AppletJmolBinding(this, ap.getStructureSelectionManager(),
 135             new PDBEntry[]
 136             { pdbentry }, new SequenceI[][]
 137             { seq }, new String[][]
 138             { chains }, protocol);
 139     jmb.setColourBySequence(true);
 140     if (pdbentry.getId() == null || pdbentry.getId().length() < 1)
 141     {
 142       if (protocol.equals(AppletFormatAdapter.PASTE))
 143       {
 144         pdbentry.setId("PASTED PDB"
 145                 + (chains == null ? "_" : chains.toString()));
 146       }
 147       else
 148       {
 149         pdbentry.setId(pdbentry.getFile());
 150       }
 151     }
 152
 153     if (jalview.bin.JalviewLite.debug)
 154     {
 155       System.err
 156               .println("AppletJmol: PDB ID is '" + pdbentry.getId() + "'");
 157     }
 158
 159     String alreadyMapped = StructureSelectionManager
 160             .getStructureSelectionManager(ap.av.applet)
 161             .alreadyMappedToFile(pdbentry.getId());
 162     MCview.PDBfile reader = null;
 163     if (alreadyMapped != null)
 164     {
 165       reader = StructureSelectionManager.getStructureSelectionManager(
 166               ap.av.applet).setMapping(seq, chains, pdbentry.getFile(),
 167               protocol);
 168       // PROMPT USER HERE TO ADD TO NEW OR EXISTING VIEW?
 169       // FOR NOW, LETS JUST OPEN A NEW WINDOW
 170     }
 171     MenuBar menuBar = new MenuBar();
 172     menuBar.add(fileMenu);
 173     fileMenu.add(mappingMenuItem);
 174     menuBar.add(viewMenu);
 175     mappingMenuItem.addActionListener(this);
 176     viewMenu.add(chainMenu);
 177     menuBar.add(coloursMenu);
 178     menuBar.add(helpMenu);
 179
 180     charge.addActionListener(this);
 181     hydro.addActionListener(this);
 182     chain.addActionListener(this);
 183     seqColour.addItemListener(this);
 184     jmolColour.addItemListener(this);
 185     zappo.addActionListener(this);
 186     taylor.addActionListener(this);
 187     helix.addActionListener(this);
 188     strand.addActionListener(this);
 189     turn.addActionListener(this);
 190     buried.addActionListener(this);
 191     purinepyrimidine.addActionListener(this);
 192     user.addActionListener(this);
 193
 194     jmolHelp.addActionListener(this);
 195
 196     coloursMenu.add(seqColour);
 197     coloursMenu.add(chain);
 198     coloursMenu.add(charge);
 199     coloursMenu.add(zappo);
 200     coloursMenu.add(taylor);
 201     coloursMenu.add(hydro);
 202     coloursMenu.add(helix);
 203     coloursMenu.add(strand);
 204     coloursMenu.add(turn);
 205     coloursMenu.add(buried);
 206     coloursMenu.add(purinepyrimidine);
 207     coloursMenu.add(user);
 208     coloursMenu.add(jmolColour);
 209     helpMenu.add(jmolHelp);
 210     this.setLayout(new BorderLayout());
 211
 212     setMenuBar(menuBar);
 213
 214     renderPanel = new RenderPanel();
 215     embedMenuIfNeeded(renderPanel);
 216     this.add(renderPanel, BorderLayout.CENTER);
 217     scriptWindow = new Panel();
 218     scriptWindow.setVisible(false);
 219     // this.add(scriptWindow, BorderLayout.SOUTH);
 220
 221     try
 222     {
 223       jmb.allocateViewer(renderPanel, true, ap.av.applet.getName()
 224               + "_jmol_", ap.av.applet.getDocumentBase(),
 225               ap.av.applet.getCodeBase(), "-applet", scriptWindow, null);
 226     } catch (Exception e)
 227     {
 228       System.err
 229               .println("Couldn't create a jmol viewer. Args to allocate viewer were:\nDocumentBase="
 230                       + ap.av.applet.getDocumentBase()
 231                       + "\nCodebase="
 232                       + ap.av.applet.getCodeBase());
 233       e.printStackTrace();
 234       dispose();
 235       return;
 236     }
 237     jmb.newJmolPopup(true, "Jmol", true);
 238
 239     this.addWindowListener(new WindowAdapter()
 240     {
 241       public void windowClosing(WindowEvent evt)
 242       {
 243         closeViewer();
 244       }
 245     });
 246     if (pdbentry.getProperty() == null)
 247     {
 248       pdbentry.setProperty(new Hashtable());
 249       pdbentry.getProperty().put("protocol", protocol);
 250     }
 251     if (pdbentry.getFile() != null)
 252     {
 253       // import structure data from pdbentry.getFile based on given protocol
 254       if (protocol.equals(AppletFormatAdapter.PASTE))
 255       {
 256         // TODO: JAL-623 : correctly record file contents for matching up later
 257         // pdbentry.getProperty().put("pdbfilehash",""+pdbentry.getFile().hashCode());
 258         loadInline(pdbentry.getFile());
 259       }
 260       else if (protocol.equals(AppletFormatAdapter.FILE)
 261               || protocol.equals(AppletFormatAdapter.URL))
 262       {
 263         jmb.viewer.openFile(pdbentry.getFile());
 264       }
 265       else
 266       {
 267         // probably CLASSLOADER based datasource..
 268         // Try and get a reader on the datasource, and pass that to Jmol
 269         try
 270         {
 271           java.io.Reader freader = null;
 272           if (reader != null)
 273           {
 274             if (jalview.bin.JalviewLite.debug)
 275             {
 276               System.err
 277                       .println("AppletJmol:Trying to reuse existing PDBfile IO parser.");
 278             }
 279             // re-use the one we opened earlier
 280             freader = reader.getReader();
 281           }
 282           if (freader == null)
 283           {
 284             if (jalview.bin.JalviewLite.debug)
 285             {
 286               System.err
 287                       .println("AppletJmol:Creating new PDBfile IO parser.");
 288             }
 289             FileParse fp = new FileParse(pdbentry.getFile(), protocol);
 290             fp.mark();
 291             // reader = new MCview.PDBfile(fp);
 292             // could set ID, etc.
 293             // if (!reader.isValid())
 294             // {
 295             // throw new Exception("Invalid datasource.
 296             // "+reader.getWarningMessage());
 297             // }
 298             // fp.reset();
 299             freader = fp.getReader();
 300           }
 301           if (freader == null)
 302           {
 303             throw new Exception(
 304                     "Invalid datasource. Could not obtain Reader.");
 305           }
 306           jmb.viewer.openReader(pdbentry.getFile(), pdbentry.getId(),
 307                   freader);
 308         } catch (Exception e)
 309         {
 310           // give up!
 311           System.err.println("Couldn't access pdbentry id="
 312                   + pdbentry.getId() + " and file=" + pdbentry.getFile()
 313                   + " using protocol=" + protocol);
 314           e.printStackTrace();
 315         }
 316       }
 317     }
 318
 319     jalview.bin.JalviewLite.addFrame(this, jmb.getViewerTitle(), 400, 400);
 320   }
 321
 322   public void loadInline(String string)
 323   {
 324     loadedInline = true;
 325     jmb.loadInline(string);
 326   }
 327
 328   void setChainMenuItems(Vector chains)
 329   {
 330     chainMenu.removeAll();
 331
 332     MenuItem menuItem = new MenuItem("All");
 333     menuItem.addActionListener(this);
 334
 335     chainMenu.add(menuItem);
 336
 337     CheckboxMenuItem menuItemCB;
 338     for (int c = 0; c < chains.size(); c++)
 339     {
 340       menuItemCB = new CheckboxMenuItem(chains.elementAt(c).toString(),
 341               true);
 342       menuItemCB.addItemListener(this);
 343       chainMenu.add(menuItemCB);
 344     }
 345   }
 346
 347   boolean allChainsSelected = false;
 348
 349   void centerViewer()
 350   {
 351     Vector toshow = new Vector();
 352     String lbl;
 353     int mlength, p, mnum;
 354     for (int i = 0; i < chainMenu.getItemCount(); i++)
 355     {
 356       if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
 357       {
 358         CheckboxMenuItem item = (CheckboxMenuItem) chainMenu.getItem(i);
 359         if (item.getState())
 360         {
 361           toshow.addElement(item.getLabel());
 362         }
 363       }
 364     }
 365     jmb.centerViewer(toshow);
 366   }
 367
 368   void closeViewer()
 369   {
 370     jmb.closeViewer();
 371     jmb = null;
 372     this.setVisible(false);
 373   }
 374
 375   public void actionPerformed(ActionEvent evt)
 376   {
 377     if (evt.getSource() == mappingMenuItem)
 378     {
 379       jalview.appletgui.CutAndPasteTransfer cap = new jalview.appletgui.CutAndPasteTransfer(
 380               false, null);
 381       Frame frame = new Frame();
 382       frame.add(cap);
 383
 384       StringBuffer sb = new StringBuffer();
 385       try
 386       {
 387         for (int s = 0; s < jmb.pdbentry.length; s++)
 388         {
 389           sb.append(jmb.printMapping(jmb.pdbentry[s].getFile()));
 390           sb.append("\n");
 391         }
 392         cap.setText(sb.toString());
 393       } catch (OutOfMemoryError ex)
 394       {
 395         frame.dispose();
 396         System.err
 397                 .println("Out of memory when trying to create dialog box with sequence-structure mapping.");
 398         return;
 399       }
 400       jalview.bin.JalviewLite.addFrame(frame, "PDB - Sequence Mapping",
 401               550, 600);
 402     }
 403     else if (evt.getSource() == charge)
 404     {
 405       setEnabled(charge);
 406       jmb.colourByCharge();
 407     }
 408
 409     else if (evt.getSource() == chain)
 410     {
 411       setEnabled(chain);
 412       jmb.colourByChain();
 413     }
 414     else if (evt.getSource() == zappo)
 415     {
 416       setEnabled(zappo);
 417       jmb.setJalviewColourScheme(new ZappoColourScheme());
 418     }
 419     else if (evt.getSource() == taylor)
 420     {
 421       setEnabled(taylor);
 422       jmb.setJalviewColourScheme(new TaylorColourScheme());
 423     }
 424     else if (evt.getSource() == hydro)
 425     {
 426       setEnabled(hydro);
 427       jmb.setJalviewColourScheme(new HydrophobicColourScheme());
 428     }
 429     else if (evt.getSource() == helix)
 430     {
 431       setEnabled(helix);
 432       jmb.setJalviewColourScheme(new HelixColourScheme());
 433     }
 434     else if (evt.getSource() == strand)
 435     {
 436       setEnabled(strand);
 437       jmb.setJalviewColourScheme(new StrandColourScheme());
 438     }
 439     else if (evt.getSource() == turn)
 440     {
 441       setEnabled(turn);
 442       jmb.setJalviewColourScheme(new TurnColourScheme());
 443     }
 444     else if (evt.getSource() == buried)
 445     {
 446       setEnabled(buried);
 447       jmb.setJalviewColourScheme(new BuriedColourScheme());
 448     }
 449     else if (evt.getSource() == purinepyrimidine)
 450     {
 451       jmb.setJalviewColourScheme(new PurinePyrimidineColourScheme());
 452     }
 453     else if (evt.getSource() == user)
 454     {
 455       setEnabled(user);
 456       new UserDefinedColours(this);
 457     }
 458     else if (evt.getSource() == jmolHelp)
 459     {
 460       try
 461       {
 462         ap.av.applet.getAppletContext().showDocument(
 463                 new java.net.URL(
 464                         "http://jmol.sourceforge.net/docs/JmolUserGuide/"),
 465                 "jmolHelp");
 466       } catch (java.net.MalformedURLException ex)
 467       {
 468       }
 469     }
 470     else
 471     {
 472       allChainsSelected = true;
 473       for (int i = 0; i < chainMenu.getItemCount(); i++)
 474       {
 475         if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
 476           ((CheckboxMenuItem) chainMenu.getItem(i)).setState(true);
 477       }
 478
 479       centerViewer();
 480       allChainsSelected = false;
 481     }
 482   }
 483
 484   /**
 485    * tick or untick the seqColour menu entry or jmoColour entry depending upon
 486    * if it was selected or not.
 487    *
 488    * @param itm
 489    */
 490   private void setEnabled(MenuItem itm)
 491   {
 492     jmolColour.setState(itm == jmolColour);
 493     seqColour.setState(itm == seqColour);
 494     jmb.setColourBySequence(itm == seqColour);
 495   }
 496
 497   public void itemStateChanged(ItemEvent evt)
 498   {
 499     if (evt.getSource() == jmolColour)
 500     {
 501       setEnabled(jmolColour);
 502       jmb.setColourBySequence(false);
 503     }
 504     else if (evt.getSource() == seqColour)
 505     {
 506       setEnabled(seqColour);
 507       jmb.colourBySequence(ap.av.getShowSequenceFeatures(), ap);
 508     }
 509     else if (!allChainsSelected)
 510       centerViewer();
 511   }
 512
 513   public void keyPressed(KeyEvent evt)
 514   {
 515     if (evt.getKeyCode() == KeyEvent.VK_ENTER && scriptWindow.isVisible())
 516     {
 517       jmb.eval(inputLine.getText());
 518       history.append("\n$ " + inputLine.getText());
 519       inputLine.setText("");
 520     }
 521
 522   }
 523
 524   public void keyTyped(KeyEvent evt)
 525   {
 526   }
 527
 528   public void keyReleased(KeyEvent evt)
 529   {
 530   }
 531
 532   public void updateColours(Object source)
 533   {
 534     AlignmentPanel ap = (AlignmentPanel) source;
 535     jmb.colourBySequence(ap.av.getShowSequenceFeatures(), ap);
 536   }
 537
 538   public void updateTitleAndMenus()
 539   {
 540     if (jmb.fileLoadingError != null && jmb.fileLoadingError.length() > 0)
 541     {
 542       repaint();
 543       return;
 544     }
 545     setChainMenuItems(jmb.chainNames);
 546     jmb.colourBySequence(ap.av.getShowSequenceFeatures(), ap);
 547
 548     setTitle(jmb.getViewerTitle());
 549   }
 550
 551   public void showUrl(String url)
 552   {
 553     try
 554     {
 555       ap.av.applet.getAppletContext().showDocument(new java.net.URL(url),
 556               "jmolOutput");
 557     } catch (java.net.MalformedURLException ex)
 558     {
 559     }
 560   }
 561
 562   Panel splitPane = null;
 563
 564   public void showConsole(boolean showConsole)
 565   {
 566     if (showConsole)
 567     {
 568       remove(renderPanel);
 569       splitPane = new Panel();
 570
 571       splitPane.setLayout(new java.awt.GridLayout(2, 1));
 572       splitPane.add(renderPanel);
 573       splitPane.add(scriptWindow);
 574       scriptWindow.setVisible(true);
 575       this.add(splitPane, BorderLayout.CENTER);
 576       splitPane.setVisible(true);
 577       splitPane.validate();
 578     }
 579     else
 580     {
 581       scriptWindow.setVisible(false);
 582       remove(splitPane);
 583       add(renderPanel, BorderLayout.CENTER);
 584       splitPane = null;
 585     }
 586     validate();
 587   }
 588
 589   public float[][] functionXY(String functionName, int x, int y)
 590   {
 591     return null;
 592   }
 593
 594   // /End JmolStatusListener
 595   // /////////////////////////////
 596
 597   class RenderPanel extends Panel
 598   {
 599     Dimension currentSize = new Dimension();
 600
 601     Rectangle rectClip = new Rectangle();
 602
 603     public void update(Graphics g)
 604     {
 605       paint(g);
 606     }
 607
 608     public void paint(Graphics g)
 609     {
 610       currentSize = this.getSize();
 611       rectClip = g.getClipBounds();
 612
 613       if (jmb.viewer == null)
 614       {
 615         g.setColor(Color.black);
 616         g.fillRect(0, 0, currentSize.width, currentSize.height);
 617         g.setColor(Color.white);
 618         g.setFont(new Font("Verdana", Font.BOLD, 14));
 619         g.drawString("Retrieving PDB data....", 20, currentSize.height / 2);
 620       }
 621       else
 622       {
 623         jmb.viewer.renderScreenImage(g, currentSize, rectClip);
 624       }
 625     }
 626   }
 627
 628   /*
 629    * @Override public Color getColour(int atomIndex, int pdbResNum, String
 630    * chain, String pdbId) { return jmb.getColour(atomIndex, pdbResNum, chain,
 631    * pdbId); }
 632    *
 633    * @Override public String[] getPdbFile() { return jmb.getPdbFile(); }
 634    *
 635    * @Override public void highlightAtom(int atomIndex, int pdbResNum, String
 636    * chain, String pdbId) { jmb.highlightAtom(atomIndex, pdbResNum, chain,
 637    * pdbId);
 638    *
 639    * }
 640    *
 641    * @Override public void mouseOverStructure(int atomIndex, String strInfo) {
 642    * jmb.mouseOverStructure(atomIndex, strInfo);
 643    *
 644    * }
 645    */
 646   public void setJalviewColourScheme(UserColourScheme ucs)
 647   {
 648     jmb.setJalviewColourScheme(ucs);
 649   }
 650
 651   public AlignmentPanel getAlignmentPanelFor(AlignmentI alignment)
 652   {
 653     for (int i = 0; i < _aps.size(); i++)
 654     {
 655       if (((AlignmentPanel) _aps.get(i)).av.getAlignment() == alignment)
 656       {
 657         return ((AlignmentPanel) _aps.get(i));
 658       }
 659     }
 660     return ap;
 661   }
 662 }