JAL-2403 redundant 'implements' removed
[jalview.git] / 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.bin.JalviewLite;
24 import jalview.datamodel.AlignmentI;
25 import jalview.datamodel.PDBEntry;
26 import jalview.datamodel.SequenceI;
27 import jalview.io.DataSourceType;
28 import jalview.io.FileParse;
29 import jalview.io.StructureFile;
30 import jalview.schemes.BuriedColourScheme;
31 import jalview.schemes.HelixColourScheme;
32 import jalview.schemes.HydrophobicColourScheme;
33 import jalview.schemes.PurinePyrimidineColourScheme;
34 import jalview.schemes.StrandColourScheme;
35 import jalview.schemes.TaylorColourScheme;
36 import jalview.schemes.TurnColourScheme;
37 import jalview.schemes.UserColourScheme;
38 import jalview.schemes.ZappoColourScheme;
39 import jalview.structure.StructureSelectionManager;
40 import jalview.util.MessageManager;
41
42 import java.awt.BorderLayout;
43 import java.awt.CheckboxMenuItem;
44 import java.awt.Color;
45 import java.awt.Dimension;
46 import java.awt.Font;
47 import java.awt.Frame;
48 import java.awt.Graphics;
49 import java.awt.Menu;
50 import java.awt.MenuBar;
51 import java.awt.MenuItem;
52 import java.awt.Panel;
53 import java.awt.TextArea;
54 import java.awt.TextField;
55 import java.awt.event.ActionEvent;
56 import java.awt.event.ActionListener;
57 import java.awt.event.ItemEvent;
58 import java.awt.event.ItemListener;
59 import java.awt.event.KeyEvent;
60 import java.awt.event.KeyListener;
61 import java.awt.event.WindowAdapter;
62 import java.awt.event.WindowEvent;
63 import java.util.ArrayList;
64 import java.util.List;
65 import java.util.Vector;
66
67 public class AppletJmol extends EmbmenuFrame implements
68 // StructureListener,
69         KeyListener, ActionListener, ItemListener
70
71 {
72   Menu fileMenu = new Menu(MessageManager.getString("action.file"));
73
74   Menu viewMenu = new Menu(MessageManager.getString("action.view"));
75
76   Menu coloursMenu = new Menu(MessageManager.getString("action.colour"));
77
78   Menu chainMenu = new Menu(MessageManager.getString("action.show_chain"));
79
80   Menu helpMenu = new Menu(MessageManager.getString("action.help"));
81
82   MenuItem mappingMenuItem = new MenuItem(
83           MessageManager.getString("label.view_mapping"));
84
85   CheckboxMenuItem seqColour = new CheckboxMenuItem(
86           MessageManager.getString("action.by_sequence"), true);
87
88   CheckboxMenuItem jmolColour = new CheckboxMenuItem(
89           MessageManager.getString("action.using_jmol"), false);
90
91   MenuItem chain = new MenuItem(MessageManager.getString("action.by_chain"));
92
93   MenuItem charge = new MenuItem(
94           MessageManager.getString("label.charge_cysteine"));
95
96   MenuItem zappo = new MenuItem(
97           MessageManager.getString("label.colourScheme_zappo"));
98
99   MenuItem taylor = new MenuItem(
100           MessageManager.getString("label.colourScheme_taylor"));
101
102   MenuItem hydro = new MenuItem(
103           MessageManager.getString("label.colourScheme_hydrophobic"));
104
105   MenuItem helix = new MenuItem(
106           MessageManager.getString("label.colourScheme_helix_propensity"));
107
108   MenuItem strand = new MenuItem(
109           MessageManager.getString("label.colourScheme_strand_propensity"));
110
111   MenuItem turn = new MenuItem(
112           MessageManager.getString("label.colourScheme_turn_propensity"));
113
114   MenuItem buried = new MenuItem(
115           MessageManager.getString("label.colourScheme_buried_index"));
116
117   MenuItem purinepyrimidine = new MenuItem(
118           MessageManager.getString("label.colourScheme_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, DataSourceType protocol)
182   {
183     this.ap = ap;
184     jmb = new AppletJmolBinding(this, ap.getStructureSelectionManager(),
185             new PDBEntry[] { pdbentry }, new SequenceI[][] { seq },
186             protocol);
187     jmb.setColourBySequence(true);
188     if (pdbentry.getId() == null || pdbentry.getId().length() < 1)
189     {
190       if (protocol == DataSourceType.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 (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     } catch (Exception e)
275     {
276       System.err
277               .println("Couldn't create a jmol viewer. Args to allocate viewer were:\nDocumentBase="
278                       + ap.av.applet.getDocumentBase()
279                       + "\nCodebase="
280                       + ap.av.applet.getCodeBase());
281       e.printStackTrace();
282       dispose();
283       return;
284     }
285     // jmb.newJmolPopup(true, "Jmol", true);
286
287     this.addWindowListener(new WindowAdapter()
288     {
289       @Override
290       public void windowClosing(WindowEvent evt)
291       {
292         closeViewer();
293       }
294     });
295     pdbentry.setProperty("protocol", protocol);
296     if (pdbentry.getFile() != null)
297     
298     {
299       // import structure data from pdbentry.getFile based on given protocol
300       if (protocol == DataSourceType.PASTE)
301       {
302         // TODO: JAL-623 : correctly record file contents for matching up later
303         // pdbentry.getProperty().put("pdbfilehash",""+pdbentry.getFile().hashCode());
304         loadInline(pdbentry.getFile());
305       }
306       else if (protocol == DataSourceType.FILE
307               || protocol == DataSourceType.URL)
308       {
309         jmb.viewer.openFile(pdbentry.getFile());
310       }
311       else
312       {
313         // probably CLASSLOADER based datasource..
314         // Try and get a reader on the datasource, and pass that to Jmol
315         try
316         {
317           java.io.Reader freader = null;
318           if (reader != null)
319           {
320             if (jalview.bin.JalviewLite.debug)
321             {
322               System.err
323                       .println("AppletJmol:Trying to reuse existing PDBfile IO parser.");
324             }
325             // re-use the one we opened earlier
326             freader = reader.getReader();
327           }
328           if (freader == null)
329           {
330             if (jalview.bin.JalviewLite.debug)
331             {
332               System.err
333                       .println("AppletJmol:Creating new PDBfile IO parser.");
334             }
335             FileParse fp = new FileParse(pdbentry.getFile(), protocol);
336             fp.mark();
337             // reader = new MCview.PDBfile(fp);
338             // could set ID, etc.
339             // if (!reader.isValid())
340             // {
341             // throw new Exception("Invalid datasource.
342             // "+reader.getWarningMessage());
343             // }
344             // fp.reset();
345             freader = fp.getReader();
346           }
347           if (freader == null)
348           {
349             throw new Exception(
350                     MessageManager
351                             .getString("exception.invalid_datasource_couldnt_obtain_reader"));
352           }
353           jmb.viewer.openReader(pdbentry.getFile(), pdbentry.getId(),
354                   freader);
355         } catch (Exception e)
356         {
357           // give up!
358           System.err.println("Couldn't access pdbentry id="
359                   + pdbentry.getId() + " and file=" + pdbentry.getFile()
360                   + " using protocol=" + protocol);
361           e.printStackTrace();
362         }
363       }
364     }
365
366     jalview.bin.JalviewLite.addFrame(this, jmb.getViewerTitle(), 400, 400);
367   }
368
369   public void loadInline(String string)
370   {
371     loadedInline = true;
372     jmb.loadInline(string);
373   }
374
375   void setChainMenuItems(List<String> chains)
376   {
377     chainMenu.removeAll();
378
379     MenuItem menuItem = new MenuItem(MessageManager.getString("label.all"));
380     menuItem.addActionListener(this);
381
382     chainMenu.add(menuItem);
383
384     CheckboxMenuItem menuItemCB;
385     for (String ch : chains)
386     {
387       menuItemCB = new CheckboxMenuItem(ch, true);
388       menuItemCB.addItemListener(this);
389       chainMenu.add(menuItemCB);
390     }
391   }
392
393   boolean allChainsSelected = false;
394
395   void centerViewer()
396   {
397     Vector<String> toshow = new Vector<String>();
398     for (int i = 0; i < chainMenu.getItemCount(); i++)
399     {
400       if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
401       {
402         CheckboxMenuItem item = (CheckboxMenuItem) chainMenu.getItem(i);
403         if (item.getState())
404         {
405           toshow.addElement(item.getLabel());
406         }
407       }
408     }
409     jmb.centerViewer(toshow);
410   }
411
412   void closeViewer()
413   {
414     jmb.closeViewer();
415     jmb = null;
416     this.setVisible(false);
417   }
418
419   @Override
420   public void actionPerformed(ActionEvent evt)
421   {
422     if (evt.getSource() == mappingMenuItem)
423     {
424       jalview.appletgui.CutAndPasteTransfer cap = new jalview.appletgui.CutAndPasteTransfer(
425               false, null);
426       Frame frame = new Frame();
427       frame.add(cap);
428
429       StringBuffer sb = new StringBuffer();
430       try
431       {
432         cap.setText(jmb.printMappings());
433       } catch (OutOfMemoryError ex)
434       {
435         frame.dispose();
436         System.err
437                 .println("Out of memory when trying to create dialog box with sequence-structure mapping.");
438         return;
439       }
440       jalview.bin.JalviewLite.addFrame(frame,
441               MessageManager.getString("label.pdb_sequence_mapping"), 550,
442               600);
443     }
444     else if (evt.getSource() == charge)
445     {
446       setEnabled(charge);
447       jmb.colourByCharge();
448     }
449
450     else if (evt.getSource() == chain)
451     {
452       setEnabled(chain);
453       jmb.colourByChain();
454     }
455     else if (evt.getSource() == zappo)
456     {
457       setEnabled(zappo);
458       jmb.setJalviewColourScheme(new ZappoColourScheme());
459     }
460     else if (evt.getSource() == taylor)
461     {
462       setEnabled(taylor);
463       jmb.setJalviewColourScheme(new TaylorColourScheme());
464     }
465     else if (evt.getSource() == hydro)
466     {
467       setEnabled(hydro);
468       jmb.setJalviewColourScheme(new HydrophobicColourScheme());
469     }
470     else if (evt.getSource() == helix)
471     {
472       setEnabled(helix);
473       jmb.setJalviewColourScheme(new HelixColourScheme());
474     }
475     else if (evt.getSource() == strand)
476     {
477       setEnabled(strand);
478       jmb.setJalviewColourScheme(new StrandColourScheme());
479     }
480     else if (evt.getSource() == turn)
481     {
482       setEnabled(turn);
483       jmb.setJalviewColourScheme(new TurnColourScheme());
484     }
485     else if (evt.getSource() == buried)
486     {
487       setEnabled(buried);
488       jmb.setJalviewColourScheme(new BuriedColourScheme());
489     }
490     else if (evt.getSource() == purinepyrimidine)
491     {
492       jmb.setJalviewColourScheme(new PurinePyrimidineColourScheme());
493     }
494     else if (evt.getSource() == user)
495     {
496       setEnabled(user);
497       new UserDefinedColours(this);
498     }
499     else if (evt.getSource() == jmolHelp)
500     {
501       try
502       {
503         ap.av.applet.getAppletContext().showDocument(
504                 new java.net.URL(
505                         "http://jmol.sourceforge.net/docs/JmolUserGuide/"),
506                 "jmolHelp");
507       } catch (java.net.MalformedURLException ex)
508       {
509       }
510     }
511     else
512     {
513       allChainsSelected = true;
514       for (int i = 0; i < chainMenu.getItemCount(); i++)
515       {
516         if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
517         {
518           ((CheckboxMenuItem) chainMenu.getItem(i)).setState(true);
519         }
520       }
521
522       centerViewer();
523       allChainsSelected = false;
524     }
525   }
526
527   /**
528    * tick or untick the seqColour menu entry or jmoColour entry depending upon
529    * if it was selected or not.
530    * 
531    * @param itm
532    */
533   private void setEnabled(MenuItem itm)
534   {
535     jmolColour.setState(itm == jmolColour);
536     seqColour.setState(itm == seqColour);
537     jmb.setColourBySequence(itm == seqColour);
538   }
539
540   @Override
541   public void itemStateChanged(ItemEvent evt)
542   {
543     if (evt.getSource() == jmolColour)
544     {
545       setEnabled(jmolColour);
546       jmb.setColourBySequence(false);
547     }
548     else if (evt.getSource() == seqColour)
549     {
550       setEnabled(seqColour);
551       jmb.colourBySequence(ap);
552     }
553     else if (!allChainsSelected)
554     {
555       centerViewer();
556     }
557   }
558
559   @Override
560   public void keyPressed(KeyEvent evt)
561   {
562     if (evt.getKeyCode() == KeyEvent.VK_ENTER && scriptWindow.isVisible())
563     {
564       jmb.eval(inputLine.getText());
565       addToHistory("$ " + inputLine.getText());
566       inputLine.setText("");
567     }
568
569   }
570
571   @Override
572   public void keyTyped(KeyEvent evt)
573   {
574   }
575
576   @Override
577   public void keyReleased(KeyEvent evt)
578   {
579   }
580
581   public void updateColours(Object source)
582   {
583     AlignmentPanel panel = (AlignmentPanel) source;
584     jmb.colourBySequence(panel);
585   }
586
587   public void updateTitleAndMenus()
588   {
589     if (jmb.hasFileLoadingError())
590     {
591       repaint();
592       return;
593     }
594     setChainMenuItems(jmb.getChainNames());
595     jmb.colourBySequence(ap);
596
597     setTitle(jmb.getViewerTitle());
598   }
599
600   public void showUrl(String url)
601   {
602     try
603     {
604       ap.av.applet.getAppletContext().showDocument(new java.net.URL(url),
605               "jmolOutput");
606     } catch (java.net.MalformedURLException ex)
607     {
608     }
609   }
610
611   Panel splitPane = null;
612
613   public void showConsole(boolean showConsole)
614   {
615     if (showConsole)
616     {
617       remove(renderPanel);
618       splitPane = new Panel();
619
620       splitPane.setLayout(new java.awt.GridLayout(2, 1));
621       splitPane.add(renderPanel);
622       splitPane.add(scriptWindow);
623       scriptWindow.setVisible(true);
624       this.add(splitPane, BorderLayout.CENTER);
625       splitPane.setVisible(true);
626       splitPane.validate();
627     }
628     else
629     {
630       scriptWindow.setVisible(false);
631       remove(splitPane);
632       add(renderPanel, BorderLayout.CENTER);
633       splitPane = null;
634     }
635     validate();
636   }
637
638   public float[][] functionXY(String functionName, int x, int y)
639   {
640     return null;
641   }
642
643   // /End JmolStatusListener
644   // /////////////////////////////
645
646   class RenderPanel extends Panel
647   {
648     Dimension currentSize = new Dimension();
649
650     @Override
651     public void update(Graphics g)
652     {
653       paint(g);
654     }
655
656     @Override
657     public void paint(Graphics g)
658     {
659       currentSize = this.getSize();
660
661       if (jmb.viewer == null)
662       {
663         g.setColor(Color.black);
664         g.fillRect(0, 0, currentSize.width, currentSize.height);
665         g.setColor(Color.white);
666         g.setFont(new Font("Verdana", Font.BOLD, 14));
667         g.drawString(MessageManager.getString("label.retrieving_pdb_data"),
668                 20, currentSize.height / 2);
669       }
670       else
671       {
672         jmb.viewer.renderScreenImage(g, currentSize.width,
673                 currentSize.height);
674       }
675     }
676   }
677
678   /*
679    * @Override public Color getColour(int atomIndex, int pdbResNum, String
680    * chain, String pdbId) { return jmb.getColour(atomIndex, pdbResNum, chain,
681    * pdbId); }
682    * 
683    * @Override public String[] getPdbFile() { return jmb.getPdbFile(); }
684    * 
685    * @Override public void highlightAtom(int atomIndex, int pdbResNum, String
686    * chain, String pdbId) { jmb.highlightAtom(atomIndex, pdbResNum, chain,
687    * pdbId);
688    * 
689    * }
690    * 
691    * @Override public void mouseOverStructure(int atomIndex, String strInfo) {
692    * jmb.mouseOverStructure(atomIndex, strInfo);
693    * 
694    * }
695    */
696   public void setJalviewColourScheme(UserColourScheme ucs)
697   {
698     jmb.setJalviewColourScheme(ucs);
699   }
700
701   public AlignmentPanel getAlignmentPanelFor(AlignmentI alignment)
702   {
703     for (int i = 0; i < _aps.size(); i++)
704     {
705       if (_aps.get(i).av.getAlignment() == alignment)
706       {
707         return (_aps.get(i));
708       }
709     }
710     return ap;
711   }
712
713   /**
714    * Append the given text to the history object
715    * 
716    * @param text
717    */
718   public void addToHistory(String text)
719   {
720     // actually currently never initialised
721     if (history != null)
722     {
723       history.append("\n" + text);
724     }
725   }
726 }