src/jalview/appletgui/AppletJmol.java

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