src/jalview/appletgui/AppletJmol.java

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