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