src/jalview/appletgui/AppletJmol.java

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