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