src/jalview/appletgui/AppletJmol.java

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