538d177ea6fdb464a0759a4d181d870ca6288e38
[jalview.git] / src / jalview / appletgui / AppletJmol.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer
3  * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
18  */
19
20 package jalview.appletgui;
21
22 import java.util.*;
23 import java.awt.*;
24 import java.awt.event.*;
25
26 import jalview.datamodel.*;
27 import jalview.structure.*;
28 import jalview.io.*;
29
30 import org.jmol.api.*;
31 import org.jmol.adapter.smarter.SmarterJmolAdapter;
32
33 import org.jmol.popup.*;
34 import jalview.schemes.*;
35
36
37 public class AppletJmol extends Frame
38     implements  StructureListener, JmolStatusListener,
39     KeyListener, ActionListener, ItemListener
40
41 {
42   Menu fileMenu = new Menu("File");
43   Menu viewMenu = new Menu("View");
44   Menu coloursMenu = new Menu("Colours");
45   Menu chainMenu = new Menu("Show Chain");
46   Menu helpMenu = new Menu("Help");
47   MenuItem mappingMenuItem = new MenuItem("View Mapping");
48
49   CheckboxMenuItem seqColour = new CheckboxMenuItem("By Sequence", true);
50   MenuItem chain = new MenuItem("By Chain");
51   MenuItem charge = new MenuItem("Charge & Cysteine");
52   MenuItem zappo = new MenuItem("Zappo");
53   MenuItem taylor = new MenuItem("Taylor");
54   MenuItem hydro = new MenuItem("Hydrophobicity");
55   MenuItem helix = new MenuItem("Helix Propensity");
56   MenuItem strand = new MenuItem("Strand Propensity");
57   MenuItem turn = new MenuItem("Turn Propensity");
58   MenuItem buried = new MenuItem("Buried Index");
59   MenuItem user = new MenuItem("User Defined Colours");
60
61   MenuItem jmolHelp = new MenuItem("Jmol Help");
62
63   JmolViewer viewer;
64   JmolPopup jmolpopup;
65
66   Panel scriptWindow;
67   TextField inputLine;
68   TextArea history;
69   SequenceI[] sequence;
70   String [] chains;
71   StructureSelectionManager ssm;
72   RenderPanel renderPanel;
73   AlignmentPanel ap;
74   String fileLoadingError;
75   boolean loadedInline;
76   PDBEntry pdbentry;
77   boolean colourBySequence = true;
78   Vector atomsPicked = new Vector();
79
80   public AppletJmol(PDBEntry pdbentry,
81                     SequenceI[] seq,
82                     String[] chains,
83                     AlignmentPanel ap,
84                     String protocol)
85   {
86     this.ap = ap;
87     this.sequence = seq;
88     this.chains = chains;
89     this.pdbentry = pdbentry;
90
91    String alreadyMapped = StructureSelectionManager
92         .getStructureSelectionManager()
93         .alreadyMappedToFile(pdbentry.getId());
94
95     if (alreadyMapped != null)
96     {
97        StructureSelectionManager.getStructureSelectionManager()
98             .setMapping(seq, chains, pdbentry.getFile(), protocol);
99        //PROMPT USER HERE TO ADD TO NEW OR EXISTING VIEW?
100        //FOR NOW, LETS JUST OPEN A NEW WINDOW
101     }
102
103     renderPanel = new RenderPanel();
104
105     this.add(renderPanel, BorderLayout.CENTER);
106     viewer = JmolViewer.allocateViewer(renderPanel, new SmarterJmolAdapter());
107
108     viewer.setAppletContext("jalview",
109                        ap.av.applet.getDocumentBase(),
110                             ap.av.applet.getCodeBase(),
111                             null);
112
113     viewer.setJmolStatusListener(this);
114
115     jmolpopup = JmolPopup.newJmolPopup(viewer);
116
117     this.addWindowListener(new WindowAdapter()
118         {
119           public void windowClosing(WindowEvent evt)
120           {
121             closeViewer();
122           }
123         });
124
125     MenuBar menuBar = new MenuBar();
126     menuBar.add(fileMenu);
127     fileMenu.add(mappingMenuItem);
128     menuBar.add(viewMenu);
129     mappingMenuItem.addActionListener(this);
130     viewMenu.add(chainMenu);
131     menuBar.add(coloursMenu);
132     menuBar.add(helpMenu);
133
134     charge.addActionListener(this);
135     hydro.addActionListener(this);
136     chain.addActionListener(this);
137     seqColour.addItemListener(this);
138     zappo.addActionListener(this);
139     taylor.addActionListener(this);
140     helix.addActionListener(this);
141     strand.addActionListener(this);
142     turn.addActionListener(this);
143     buried.addActionListener(this);
144     user.addActionListener(this);
145
146     jmolHelp.addActionListener(this);
147
148     coloursMenu.add(seqColour);
149     coloursMenu.add(chain);
150     coloursMenu.add(charge);
151     coloursMenu.add(zappo);
152     coloursMenu.add(taylor);
153     coloursMenu.add(hydro);
154     coloursMenu.add(helix);
155     coloursMenu.add(strand);
156     coloursMenu.add(turn);
157     coloursMenu.add(buried);
158     coloursMenu.add(user);
159
160     helpMenu.add(jmolHelp);
161
162     this.setMenuBar(menuBar);
163
164     if(pdbentry.getFile()!=null)
165     {
166       if (protocol.equals(AppletFormatAdapter.PASTE))
167         loadInline(pdbentry.getFile());
168       else
169           viewer.openFile(pdbentry.getFile());
170     }
171
172     jalview.bin.JalviewLite.addFrame(this, "Jmol", 400,400);
173   }
174
175   public void loadInline(String string)
176   {
177     loadedInline = true;
178     viewer.openStringInline(string);
179   }
180
181
182   void setChainMenuItems(Vector chains)
183   {
184     chainMenu.removeAll();
185
186     MenuItem menuItem = new MenuItem("All");
187     menuItem.addActionListener(this);
188
189     chainMenu.add(menuItem);
190
191     CheckboxMenuItem menuItemCB;
192     for (int c = 0; c < chains.size(); c++)
193     {
194       menuItemCB = new CheckboxMenuItem(chains.elementAt(c).toString(), true);
195       menuItemCB.addItemListener(this);
196       chainMenu.add(menuItemCB);
197     }
198   }
199
200   boolean allChainsSelected = false;
201   void centerViewer()
202   {
203     StringBuffer cmd = new StringBuffer();
204     for (int i = 0; i < chainMenu.getItemCount(); i++)
205     {
206       if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
207       {
208         CheckboxMenuItem item = (CheckboxMenuItem) chainMenu.getItem(i);
209         if (item.getState())
210           cmd.append(":" + item.getLabel() + " or ");
211       }
212     }
213
214     if (cmd.length() > 0)
215       cmd.setLength(cmd.length() - 4);
216
217     viewer.evalString("select *;restrict "
218                       + cmd + ";cartoon;center " + cmd);
219   }
220
221
222   void closeViewer()
223   {
224     viewer.setModeMouse(org.jmol.viewer.JmolConstants.MOUSE_NONE);
225     viewer.evalStringQuiet("zap");
226     viewer.setJmolStatusListener(null);
227     viewer = null;
228
229     //We'll need to find out what other
230     // listeners need to be shut down in Jmol
231     StructureSelectionManager
232         .getStructureSelectionManager()
233         .removeStructureViewerListener(this, pdbentry.getId());
234
235     this.setVisible(false);
236   }
237
238   public void actionPerformed(ActionEvent evt)
239   {
240     if(evt.getSource()==mappingMenuItem)
241     {
242       jalview.appletgui.CutAndPasteTransfer cap
243           = new jalview.appletgui.CutAndPasteTransfer(false, null);
244       Frame frame = new Frame();
245       frame.add(cap);
246
247       jalview.bin.JalviewLite.addFrame(frame, "PDB - Sequence Mapping", 550,
248                                        600);
249       cap.setText(
250           StructureSelectionManager.getStructureSelectionManager().printMapping(
251               pdbentry.getFile())
252           );
253     }
254     else if (evt.getSource() == charge)
255     {
256       colourBySequence = false;
257       seqColour.setState(false);
258       viewer.evalStringQuiet("select *;color white;select ASP,GLU;color red;"
259                       +"select LYS,ARG;color blue;select CYS;color yellow");
260     }
261
262     else if (evt.getSource() == chain)
263     {
264       colourBySequence = false;
265       seqColour.setState(false);
266       viewer.evalStringQuiet("select *;color chain");
267     }
268     else if (evt.getSource() == zappo)
269     {
270       setJalviewColourScheme(new ZappoColourScheme());
271     }
272     else if (evt.getSource() == taylor)
273     {
274      setJalviewColourScheme(new TaylorColourScheme());
275     }
276     else if (evt.getSource() == hydro)
277     {
278       setJalviewColourScheme(new HydrophobicColourScheme());
279     }
280     else if (evt.getSource() == helix)
281     {
282       setJalviewColourScheme(new HelixColourScheme());
283     }
284     else if (evt.getSource() == strand)
285     {
286       setJalviewColourScheme(new StrandColourScheme());
287     }
288     else if (evt.getSource() == turn)
289     {
290       setJalviewColourScheme(new TurnColourScheme());
291     }
292     else if (evt.getSource() == buried)
293     {
294       setJalviewColourScheme(new BuriedColourScheme());
295     }
296     else if (evt.getSource() == user)
297     {
298       new UserDefinedColours(this);
299     }
300     else if(evt.getSource() == jmolHelp)
301     {
302       try{
303         ap.av.applet.getAppletContext().showDocument(
304             new java.net.URL("http://jmol.sourceforge.net/docs/JmolUserGuide/"),
305             "jmolHelp");
306       }catch(java.net.MalformedURLException ex){}
307     }
308     else
309     {
310       allChainsSelected = true;
311       for (int i = 0; i < chainMenu.getItemCount(); i++)
312       {
313         if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
314           ( (CheckboxMenuItem) chainMenu.getItem(i)).setState(true);
315       }
316       centerViewer();
317       allChainsSelected = false;
318     }
319   }
320
321   public void setJalviewColourScheme(ColourSchemeI cs)
322   {
323     colourBySequence = false;
324     seqColour.setState(false);
325
326     if(cs==null)
327       return;
328
329     String res;
330     int index;
331     Color col;
332
333     Enumeration en = ResidueProperties.aa3Hash.keys();
334     StringBuffer command = new StringBuffer("select *;color white;");
335     while(en.hasMoreElements())
336     {
337       res = en.nextElement().toString();
338       index = ((Integer) ResidueProperties.aa3Hash.get(res)).intValue();
339       if(index>20)
340         continue;
341
342       col = cs.findColour(ResidueProperties.aa[index].charAt(0));
343
344       command.append("select "+res+";color["
345                         + col.getRed() + ","
346                         + col.getGreen() + ","
347                         + col.getBlue() + "];");
348     }
349
350     viewer.evalStringQuiet(command.toString());
351   }
352
353   public void itemStateChanged(ItemEvent evt)
354   {
355     if (evt.getSource() == seqColour)
356     {
357       colourBySequence = seqColour.getState();
358       colourBySequence(ap);
359     }
360     else if (!allChainsSelected)
361       centerViewer();
362   }
363
364   public void keyPressed(KeyEvent evt)
365   {
366     if (evt.getKeyCode() == KeyEvent.VK_ENTER
367         && scriptWindow.isVisible())
368     {
369       viewer.evalString(inputLine.getText());
370       history.append("\n$ "+inputLine.getText());
371       inputLine.setText("");
372     }
373
374   }
375
376   public void keyTyped(KeyEvent evt)
377   {  }
378
379   public void keyReleased(KeyEvent evt){}
380
381   //////////////////////////////////
382   ///StructureListener
383   public String getPdbFile()
384   {
385     return "???";
386   }
387
388
389
390   String lastMessage;
391   public void mouseOverStructure(int atomIndex, String strInfo)
392   {
393       int pdbResNum;
394
395       int chainSeparator = strInfo.indexOf(":");
396
397       if(chainSeparator==-1)
398         chainSeparator = strInfo.indexOf(".");
399
400       pdbResNum = Integer.parseInt(
401           strInfo.substring(strInfo.indexOf("]")+ 1, chainSeparator));
402
403       String chainId;
404
405       if (strInfo.indexOf(":") > -1)
406         chainId = strInfo.substring
407             (strInfo.indexOf(":")+1, strInfo.indexOf("."));
408       else
409       {
410         chainId = " ";
411       }
412
413       if (lastMessage == null || !lastMessage.equals(strInfo))
414         ssm.mouseOverStructure(pdbResNum, chainId, pdbentry.getFile());
415
416       lastMessage = strInfo;
417   }
418
419   StringBuffer resetLastRes = new StringBuffer();
420   StringBuffer eval = new StringBuffer();
421
422   public void highlightAtom(int atomIndex, int pdbResNum, String chain, String pdbfile)
423   {
424     if (!pdbfile.equals(pdbentry.getFile()))
425       return;
426
427     if (resetLastRes.length() > 0)
428     {
429       viewer.evalStringQuiet(resetLastRes.toString());
430     }
431
432     eval.setLength(0);
433     eval.append("select " + pdbResNum);
434
435     resetLastRes.setLength(0);
436     resetLastRes.append("select " + pdbResNum);
437
438     if (!chain.equals(" "))
439     {
440       eval.append(":" + chain);
441       resetLastRes.append(":" + chain);
442     }
443
444     eval.append(";color gold;wireframe 100");
445
446     Color col = new Color(viewer.getAtomArgb(atomIndex));
447
448     resetLastRes.append(";color["
449                         + col.getRed() + ","
450                         + col.getGreen() + ","
451                         + col.getBlue() + "];wireframe 0");
452
453     viewer.evalStringQuiet(eval.toString());
454
455   }
456
457   public void updateColours(Object source)
458   {
459     colourBySequence( (AlignmentPanel) source);
460   }
461
462 //End StructureListener
463 ////////////////////////////
464
465   public Color getColour(int atomIndex, int pdbResNum, String chain, String pdbfile)
466   {
467     if (!pdbfile.equals(pdbentry.getFile()))
468       return null;
469
470     return new Color(viewer.getAtomArgb(atomIndex));
471   }
472
473   FeatureRenderer fr;
474   String lastCommand;
475   public void colourBySequence(AlignmentPanel ap)
476   {
477     if(!colourBySequence)
478       return;
479
480
481     StructureMapping[] mapping = ssm.getMapping(pdbentry.getFile());
482
483     if (mapping.length < 1)
484       return;
485
486     SequenceRenderer sr = new SequenceRenderer(ap.av);
487
488     boolean showFeatures = false;
489     if (ap.av.showSequenceFeatures)
490     {
491       showFeatures = true;
492       if (fr == null)
493       {
494         fr = new jalview.appletgui.FeatureRenderer(ap.av);
495       }
496
497       fr.transferSettings(ap.seqPanel.seqCanvas.getFeatureRenderer());
498     }
499
500     StringBuffer command = new StringBuffer();
501
502     int lastPos = -1;
503     for (int s = 0; s < sequence.length; s++)
504     {
505       for (int m = 0; m < mapping.length; m++)
506       {
507         if (mapping[m].getSequence() == sequence[s]
508             && ap.av.alignment.findIndex(sequence[s])>-1)
509         {
510           for (int r = 0; r < sequence[s].getLength(); r++)
511           {
512             int pos = mapping[m].getPDBResNum(
513                 sequence[s].findPosition(r));
514
515             if (pos < 1 || pos==lastPos)
516               continue;
517
518             lastPos = pos;
519
520             Color col = sr.getResidueBoxColour(sequence[s], r);
521
522             if (showFeatures)
523               col = fr.findFeatureColour(col, sequence[s], r);
524
525             if (command.toString().endsWith(":" + mapping[m].getChain()+
526                                             ";color["
527                                             + col.getRed() + ","
528                                             + col.getGreen() + ","
529                                             + col.getBlue() + "]"))
530             {
531               command = condenseCommand(command.toString(), pos);
532               continue;
533             }
534
535             command.append(";select " + pos);
536
537             if (!mapping[m].getChain().equals(" "))
538             {
539               command.append(":" + mapping[m].getChain());
540             }
541
542             command.append(";color["
543                              + col.getRed() + ","
544                              + col.getGreen() + ","
545                              + col.getBlue() + "]");
546
547           }
548           break;
549         }
550       }
551     }
552
553     if (lastCommand != null && !lastCommand.equals(command.toString()))
554       viewer.evalStringQuiet(command.toString());
555
556     lastCommand = command.toString();
557   }
558
559   StringBuffer condenseCommand(String command, int pos)
560   {
561
562     StringBuffer sb = new StringBuffer(command.substring(0, command.lastIndexOf("select")+7));
563
564     command = command.substring(sb.length());
565
566     String start;
567
568     if (command.indexOf("-") > -1)
569     {
570       start = command.substring(0,command.indexOf("-"));
571     }
572     else
573     {
574       start = command.substring(0, command.indexOf(":"));
575     }
576
577     sb.append(start+"-"+pos+command.substring(command.indexOf(":")));
578
579     return sb;
580   }
581
582   /////////////////////////////////
583   //JmolStatusListener
584
585   public String eval(String strEval)
586   {
587    // System.out.println(strEval);
588    //"# 'eval' is implemented only for the applet.";
589     return null;
590   }
591
592   public void createImage(String file, String type, int quality)
593   {}
594
595   public void setCallbackFunction(String callbackType,
596                                   String callbackFunction)
597   {}
598
599   public void notifyFileLoaded(String fullPathName, String fileName,
600                                String modelName, Object clientFile,
601                                String errorMsg)
602   {
603     if(errorMsg!=null)
604     {
605       fileLoadingError = errorMsg;
606       repaint();
607       return;
608     }
609
610     fileLoadingError = null;
611
612     if (fileName != null)
613     {
614       //FILE LOADED OK
615       jmolpopup.updateComputedMenus();
616             viewer.evalStringQuiet(
617           "select backbone;restrict;cartoon;wireframe off;spacefill off");
618
619       ssm = StructureSelectionManager.getStructureSelectionManager();
620
621       MCview.PDBfile pdb;
622       if (loadedInline)
623       {
624         pdb = ssm.setMapping(sequence,chains,
625                                 pdbentry.getFile(),
626                                 AppletFormatAdapter.PASTE);
627         pdbentry.setFile("INLINE"+pdb.id);
628       }
629       else
630       {
631          pdb = ssm.setMapping(sequence,chains,
632                               pdbentry.getFile(),
633                               AppletFormatAdapter.URL);
634       }
635
636       pdbentry.setId(pdb.id);
637
638       ssm.addStructureViewerListener(this);
639
640       Vector chains = new Vector();
641       for (int i = 0; i < pdb.chains.size(); i++)
642       {
643         chains.addElement( ( (MCview.PDBChain) pdb.chains.elementAt(i)).id);
644       }
645       setChainMenuItems(chains);
646
647       colourBySequence(ap);
648
649       StringBuffer title = new StringBuffer(sequence[0].getName() + ":" +
650                                             pdbentry.getId());
651
652       if (pdbentry.getProperty() != null)
653       {
654         if (pdbentry.getProperty().get("method") != null)
655         {
656           title.append(" Method: ");
657           title.append(pdbentry.getProperty().get("method"));
658         }
659         if (pdbentry.getProperty().get("chains") != null)
660         {
661           title.append(" Chain:");
662           title.append(pdbentry.getProperty().get("chains"));
663         }
664       }
665
666       this.setTitle(title.toString());
667
668     }
669     else
670       return;
671   }
672
673   public void notifyFrameChanged(int frameNo)
674   {
675     boolean isAnimationRunning = (frameNo <= -2);
676   }
677
678   public void notifyScriptStart(String statusMessage, String additionalInfo)
679   {}
680
681   public void sendConsoleEcho(String strEcho)
682   {
683     if (scriptWindow == null)
684       showConsole(true);
685
686     history.append("\n"+strEcho);
687   }
688
689   public void sendConsoleMessage(String strStatus)
690   {
691     if(history!=null && strStatus!=null
692        && !strStatus.equals("Script completed"))
693     {
694       history.append("\n"+strStatus);
695     }
696   }
697
698   public void notifyScriptTermination(String strStatus, int msWalltime)
699   {  }
700
701   public void handlePopupMenu(int x, int y)
702   {
703     jmolpopup.show(x, y);
704   }
705
706   public void notifyNewPickingModeMeasurement(int iatom, String strMeasure)
707   {
708     notifyAtomPicked(iatom, strMeasure);
709   }
710
711   public void notifyNewDefaultModeMeasurement(int count, String strInfo)
712   {}
713
714   public void notifyAtomPicked(int atomIndex, String strInfo)
715   {
716
717     int chainSeparator = strInfo.indexOf(":");
718
719     if(chainSeparator==-1)
720       chainSeparator = strInfo.indexOf(".");
721
722     String picked =
723         strInfo.substring(strInfo.indexOf("]")+ 1, chainSeparator);
724
725
726     if (strInfo.indexOf(":") > -1)
727       picked+=strInfo.substring(strInfo.indexOf(":")+1,
728                                strInfo.indexOf("."));
729
730     picked+=".C";
731
732     if (!atomsPicked.contains(picked))
733     {
734       viewer.evalString("select "+picked+";label %n %r:%c");
735       atomsPicked.addElement(picked);
736     }
737     else
738     {
739       viewer.evalString("select "+picked+";label off");
740       atomsPicked.removeElement(picked);
741     }
742   }
743
744   public void notifyAtomHovered(int atomIndex, String strInfo)
745   {
746     mouseOverStructure(atomIndex, strInfo);
747   }
748
749   public void sendSyncScript(String script, String appletName)
750   {}
751
752   public void showUrl(String url)
753   {
754     try{
755       ap.av.applet.getAppletContext().showDocument(new java.net.URL(url),
756           "jmolOutput");
757     }catch(java.net.MalformedURLException ex)
758     {}
759   }
760
761   public void showConsole(boolean showConsole)
762   {
763     if (scriptWindow == null)
764     {
765       scriptWindow = new Panel(new BorderLayout());
766       inputLine = new TextField();
767       history = new TextArea(5, 40);
768       scriptWindow.add(history, BorderLayout.CENTER);
769       scriptWindow.add(inputLine, BorderLayout.SOUTH);
770       add(scriptWindow, BorderLayout.SOUTH);
771       scriptWindow.setVisible(false);
772       history.setEditable(false);
773       inputLine.addKeyListener(this);
774     }
775
776     scriptWindow.setVisible(!scriptWindow.isVisible());
777     validate();
778   }
779
780   public float functionXY(String functionName, int x, int y)
781   {
782     return 0;
783   }
784
785   ///End JmolStatusListener
786   ///////////////////////////////
787
788
789   class RenderPanel
790       extends Panel
791   {
792     Dimension currentSize = new Dimension();
793     Rectangle rectClip = new Rectangle();
794
795     public void update(Graphics g) {
796       paint(g);
797     }
798     public void paint(Graphics g)
799     {
800       currentSize = this.getSize();
801       rectClip = g.getClipBounds();
802
803       if (viewer == null)
804       {
805         g.setColor(Color.black);
806         g.fillRect(0, 0, currentSize.width, currentSize.height);
807         g.setColor(Color.white);
808         g.setFont(new Font("Verdana", Font.BOLD, 14));
809         g.drawString("Retrieving PDB data....", 20, currentSize.height / 2);
810       }
811       else
812       {
813         viewer.renderScreenImage(g, currentSize, rectClip);
814       }
815     }
816   }
817
818 }