src/jalview/appletgui/AppletJmol.java

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