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.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     StructureFile 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       @Override
 287       public void windowClosing(WindowEvent evt)
 288       {
 289         closeViewer();
 290       }
 291     });
 292     pdbentry.setProperty("protocol", protocol);
 293
 294     if (pdbentry.getFile() != null)
 295     {
 296       // import structure data from pdbentry.getFile based on given protocol
 297       if (protocol.equals(AppletFormatAdapter.PASTE))
 298       {
 299         // TODO: JAL-623 : correctly record file contents for matching up later
 300         // pdbentry.getProperty().put("pdbfilehash",""+pdbentry.getFile().hashCode());
 301         loadInline(pdbentry.getFile());
 302       }
 303       else if (protocol.equals(AppletFormatAdapter.FILE)
 304               || protocol.equals(AppletFormatAdapter.URL))
 305       {
 306         jmb.viewer.openFile(pdbentry.getFile());
 307       }
 308       else
 309       {
 310         // probably CLASSLOADER based datasource..
 311         // Try and get a reader on the datasource, and pass that to Jmol
 312         try
 313         {
 314           java.io.Reader freader = null;
 315           if (reader != null)
 316           {
 317             if (jalview.bin.JalviewLite.debug)
 318             {
 319               System.err
 320                       .println("AppletJmol:Trying to reuse existing PDBfile IO parser.");
 321             }
 322             // re-use the one we opened earlier
 323             freader = reader.getReader();
 324           }
 325           if (freader == null)
 326           {
 327             if (jalview.bin.JalviewLite.debug)
 328             {
 329               System.err
 330                       .println("AppletJmol:Creating new PDBfile IO parser.");
 331             }
 332             FileParse fp = new FileParse(pdbentry.getFile(), protocol);
 333             fp.mark();
 334             // reader = new MCview.PDBfile(fp);
 335             // could set ID, etc.
 336             // if (!reader.isValid())
 337             // {
 338             // throw new Exception("Invalid datasource.
 339             // "+reader.getWarningMessage());
 340             // }
 341             // fp.reset();
 342             freader = fp.getReader();
 343           }
 344           if (freader == null)
 345           {
 346             throw new Exception(
 347                     MessageManager
 348                             .getString("exception.invalid_datasource_couldnt_obtain_reader"));
 349           }
 350           jmb.viewer.openReader(pdbentry.getFile(), pdbentry.getId(),
 351                   freader);
 352         } catch (Exception e)
 353         {
 354           // give up!
 355           System.err.println("Couldn't access pdbentry id="
 356                   + pdbentry.getId() + " and file=" + pdbentry.getFile()
 357                   + " using protocol=" + protocol);
 358           e.printStackTrace();
 359         }
 360       }
 361     }
 362
 363     jalview.bin.JalviewLite.addFrame(this, jmb.getViewerTitle(), 400, 400);
 364   }
 365
 366   public void loadInline(String string)
 367   {
 368     loadedInline = true;
 369     jmb.loadInline(string);
 370   }
 371
 372   void setChainMenuItems(Vector<String> chains)
 373   {
 374     chainMenu.removeAll();
 375
 376     MenuItem menuItem = new MenuItem(MessageManager.getString("label.all"));
 377     menuItem.addActionListener(this);
 378
 379     chainMenu.add(menuItem);
 380
 381     CheckboxMenuItem menuItemCB;
 382     for (String ch : chains)
 383     {
 384       menuItemCB = new CheckboxMenuItem(ch, true);
 385       menuItemCB.addItemListener(this);
 386       chainMenu.add(menuItemCB);
 387     }
 388   }
 389
 390   boolean allChainsSelected = false;
 391
 392   void centerViewer()
 393   {
 394     Vector<String> toshow = new Vector<String>();
 395     for (int i = 0; i < chainMenu.getItemCount(); i++)
 396     {
 397       if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
 398       {
 399         CheckboxMenuItem item = (CheckboxMenuItem) chainMenu.getItem(i);
 400         if (item.getState())
 401         {
 402           toshow.addElement(item.getLabel());
 403         }
 404       }
 405     }
 406     jmb.centerViewer(toshow);
 407   }
 408
 409   void closeViewer()
 410   {
 411     jmb.closeViewer();
 412     jmb = null;
 413     this.setVisible(false);
 414   }
 415
 416   @Override
 417   public void actionPerformed(ActionEvent evt)
 418   {
 419     if (evt.getSource() == mappingMenuItem)
 420     {
 421       jalview.appletgui.CutAndPasteTransfer cap = new jalview.appletgui.CutAndPasteTransfer(
 422               false, null);
 423       Frame frame = new Frame();
 424       frame.add(cap);
 425
 426       StringBuffer sb = new StringBuffer();
 427       try
 428       {
 429         cap.setText(jmb.printMappings());
 430       } catch (OutOfMemoryError ex)
 431       {
 432         frame.dispose();
 433         System.err
 434                 .println("Out of memory when trying to create dialog box with sequence-structure mapping.");
 435         return;
 436       }
 437       jalview.bin.JalviewLite.addFrame(frame,
 438               MessageManager.getString("label.pdb_sequence_mapping"), 550,
 439               600);
 440     }
 441     else if (evt.getSource() == charge)
 442     {
 443       setEnabled(charge);
 444       jmb.colourByCharge();
 445     }
 446
 447     else if (evt.getSource() == chain)
 448     {
 449       setEnabled(chain);
 450       jmb.colourByChain();
 451     }
 452     else if (evt.getSource() == zappo)
 453     {
 454       setEnabled(zappo);
 455       jmb.setJalviewColourScheme(new ZappoColourScheme());
 456     }
 457     else if (evt.getSource() == taylor)
 458     {
 459       setEnabled(taylor);
 460       jmb.setJalviewColourScheme(new TaylorColourScheme());
 461     }
 462     else if (evt.getSource() == hydro)
 463     {
 464       setEnabled(hydro);
 465       jmb.setJalviewColourScheme(new HydrophobicColourScheme());
 466     }
 467     else if (evt.getSource() == helix)
 468     {
 469       setEnabled(helix);
 470       jmb.setJalviewColourScheme(new HelixColourScheme());
 471     }
 472     else if (evt.getSource() == strand)
 473     {
 474       setEnabled(strand);
 475       jmb.setJalviewColourScheme(new StrandColourScheme());
 476     }
 477     else if (evt.getSource() == turn)
 478     {
 479       setEnabled(turn);
 480       jmb.setJalviewColourScheme(new TurnColourScheme());
 481     }
 482     else if (evt.getSource() == buried)
 483     {
 484       setEnabled(buried);
 485       jmb.setJalviewColourScheme(new BuriedColourScheme());
 486     }
 487     else if (evt.getSource() == purinepyrimidine)
 488     {
 489       jmb.setJalviewColourScheme(new PurinePyrimidineColourScheme());
 490     }
 491     else if (evt.getSource() == user)
 492     {
 493       setEnabled(user);
 494       new UserDefinedColours(this);
 495     }
 496     else if (evt.getSource() == jmolHelp)
 497     {
 498       try
 499       {
 500         ap.av.applet.getAppletContext().showDocument(
 501                 new java.net.URL(
 502                         "http://jmol.sourceforge.net/docs/JmolUserGuide/"),
 503                 "jmolHelp");
 504       } catch (java.net.MalformedURLException ex)
 505       {
 506       }
 507     }
 508     else
 509     {
 510       allChainsSelected = true;
 511       for (int i = 0; i < chainMenu.getItemCount(); i++)
 512       {
 513         if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
 514         {
 515           ((CheckboxMenuItem) chainMenu.getItem(i)).setState(true);
 516         }
 517       }
 518
 519       centerViewer();
 520       allChainsSelected = false;
 521     }
 522   }
 523
 524   /**
 525    * tick or untick the seqColour menu entry or jmoColour entry depending upon
 526    * if it was selected or not.
 527    *
 528    * @param itm
 529    */
 530   private void setEnabled(MenuItem itm)
 531   {
 532     jmolColour.setState(itm == jmolColour);
 533     seqColour.setState(itm == seqColour);
 534     jmb.setColourBySequence(itm == seqColour);
 535   }
 536
 537   @Override
 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   @Override
 557   public void keyPressed(KeyEvent evt)
 558   {
 559     if (evt.getKeyCode() == KeyEvent.VK_ENTER && scriptWindow.isVisible())
 560     {
 561       jmb.eval(inputLine.getText());
 562       addToHistory("$ " + inputLine.getText());
 563       inputLine.setText("");
 564     }
 565
 566   }
 567
 568   @Override
 569   public void keyTyped(KeyEvent evt)
 570   {
 571   }
 572
 573   @Override
 574   public void keyReleased(KeyEvent evt)
 575   {
 576   }
 577
 578   public void updateColours(Object source)
 579   {
 580     AlignmentPanel panel = (AlignmentPanel) source;
 581     jmb.colourBySequence(panel);
 582   }
 583
 584   public void updateTitleAndMenus()
 585   {
 586     if (jmb.fileLoadingError != null && jmb.fileLoadingError.length() > 0)
 587     {
 588       repaint();
 589       return;
 590     }
 591     setChainMenuItems(jmb.chainNames);
 592     jmb.colourBySequence(ap);
 593
 594     setTitle(jmb.getViewerTitle());
 595   }
 596
 597   public void showUrl(String url)
 598   {
 599     try
 600     {
 601       ap.av.applet.getAppletContext().showDocument(new java.net.URL(url),
 602               "jmolOutput");
 603     } catch (java.net.MalformedURLException ex)
 604     {
 605     }
 606   }
 607
 608   Panel splitPane = null;
 609
 610   public void showConsole(boolean showConsole)
 611   {
 612     if (showConsole)
 613     {
 614       remove(renderPanel);
 615       splitPane = new Panel();
 616
 617       splitPane.setLayout(new java.awt.GridLayout(2, 1));
 618       splitPane.add(renderPanel);
 619       splitPane.add(scriptWindow);
 620       scriptWindow.setVisible(true);
 621       this.add(splitPane, BorderLayout.CENTER);
 622       splitPane.setVisible(true);
 623       splitPane.validate();
 624     }
 625     else
 626     {
 627       scriptWindow.setVisible(false);
 628       remove(splitPane);
 629       add(renderPanel, BorderLayout.CENTER);
 630       splitPane = null;
 631     }
 632     validate();
 633   }
 634
 635   public float[][] functionXY(String functionName, int x, int y)
 636   {
 637     return null;
 638   }
 639
 640   // /End JmolStatusListener
 641   // /////////////////////////////
 642
 643   class RenderPanel extends Panel
 644   {
 645     Dimension currentSize = new Dimension();
 646
 647     @Override
 648     public void update(Graphics g)
 649     {
 650       paint(g);
 651     }
 652
 653     @Override
 654     public void paint(Graphics g)
 655     {
 656       currentSize = this.getSize();
 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.width,
 670                 currentSize.height);
 671       }
 672     }
 673   }
 674
 675   /*
 676    * @Override public Color getColour(int atomIndex, int pdbResNum, String
 677    * chain, String pdbId) { return jmb.getColour(atomIndex, pdbResNum, chain,
 678    * pdbId); }
 679    *
 680    * @Override public String[] getPdbFile() { return jmb.getPdbFile(); }
 681    *
 682    * @Override public void highlightAtom(int atomIndex, int pdbResNum, String
 683    * chain, String pdbId) { jmb.highlightAtom(atomIndex, pdbResNum, chain,
 684    * pdbId);
 685    *
 686    * }
 687    *
 688    * @Override public void mouseOverStructure(int atomIndex, String strInfo) {
 689    * jmb.mouseOverStructure(atomIndex, strInfo);
 690    *
 691    * }
 692    */
 693   public void setJalviewColourScheme(UserColourScheme ucs)
 694   {
 695     jmb.setJalviewColourScheme(ucs);
 696   }
 697
 698   public AlignmentPanel getAlignmentPanelFor(AlignmentI alignment)
 699   {
 700     for (int i = 0; i < _aps.size(); i++)
 701     {
 702       if (_aps.get(i).av.getAlignment() == alignment)
 703       {
 704         return (_aps.get(i));
 705       }
 706     }
 707     return ap;
 708   }
 709
 710   /**
 711    * Append the given text to the history object
 712    *
 713    * @param text
 714    */
 715   public void addToHistory(String text)
 716   {
 717     // actually currently never initialised
 718     if (history != null)
 719     {
 720       history.append("\n" + text);
 721     }
 722   }
 723 }