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