JAL-1759 corrected syntax for 'atom picked' callback (toggles label
[jalview.git] / src / jalview / gui / AppJmolBinding.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.gui;
22
23 import jalview.api.AlignmentViewPanel;
24 import jalview.bin.Cache;
25 import jalview.datamodel.PDBEntry;
26 import jalview.datamodel.SequenceI;
27 import jalview.ext.jmol.JalviewJmolBinding;
28 import jalview.structure.StructureSelectionManager;
29
30 import java.awt.Container;
31 import java.util.Map;
32
33 import org.jmol.api.JmolAppConsoleInterface;
34 import org.jmol.java.BS;
35 import org.openscience.jmol.app.jmolpanel.console.AppConsole;
36
37 public class AppJmolBinding extends JalviewJmolBinding
38 {
39   private AppJmol appJmolWindow;
40
41   private FeatureRenderer fr = null;
42
43   public AppJmolBinding(AppJmol appJmol, StructureSelectionManager sSm,
44           PDBEntry[] pdbentry, SequenceI[][] sequenceIs, String[][] chains,
45           String protocol)
46   {
47     super(sSm, pdbentry, sequenceIs, chains, protocol);
48     appJmolWindow = appJmol;
49   }
50
51   @Override
52   public FeatureRenderer getFeatureRenderer(
53           AlignmentViewPanel alignment)
54   {
55     AlignmentPanel ap = (alignment == null) ? appJmolWindow.getAlignmentPanel()
56             : (AlignmentPanel) alignment;
57     if (ap.av.isShowSequenceFeatures())
58     {
59       if (fr == null)
60       {
61         fr = (jalview.gui.FeatureRenderer) ap.cloneFeatureRenderer();
62       }
63       else
64       {
65         ap.updateFeatureRenderer(fr);
66       }
67     }
68
69     return fr;
70   }
71
72   @Override
73   public SequenceRenderer getSequenceRenderer(
74           AlignmentViewPanel alignment)
75   {
76     return new SequenceRenderer(((AlignmentPanel) alignment).av);
77   }
78
79   @Override
80   public void sendConsoleEcho(String strEcho)
81   {
82     if (console != null)
83     {
84       console.sendConsoleEcho(strEcho);
85     }
86   }
87
88   @Override
89   public void sendConsoleMessage(String strStatus)
90   {
91     if (console != null && strStatus != null)
92     // && !strStatus.equals("Script completed"))
93     // should we squash the script completed string ?
94     {
95       console.sendConsoleMessage(strStatus);
96     }
97   }
98
99   @Override
100   public void showUrl(String url, String target)
101   {
102     try
103     {
104       jalview.util.BrowserLauncher.openURL(url);
105     } catch (Exception e)
106     {
107       Cache.log.error("Failed to launch Jmol-associated url " + url, e);
108       // TODO: 2.6 : warn user if browser was not configured.
109     }
110   }
111
112   @Override
113   public void refreshGUI()
114   {
115     // appJmolWindow.repaint();
116     javax.swing.SwingUtilities.invokeLater(new Runnable()
117     {
118       public void run()
119       {
120         appJmolWindow.updateTitleAndMenus();
121         appJmolWindow.revalidate();
122       }
123     });
124   }
125
126   public void updateColours(Object source)
127   {
128     AlignmentPanel ap = (AlignmentPanel) source;
129     // ignore events from panels not used to colour this view
130     if (!appJmolWindow.isUsedforcolourby(ap))
131     {
132       return;
133     }
134     if (!isLoadingFromArchive())
135     {
136       colourBySequence(ap);
137     }
138   }
139
140   @Override
141   public void notifyScriptTermination(String strStatus, int msWalltime)
142   {
143     // todo - script termination doesn't happen ?
144     // if (console != null)
145     // console.notifyScriptTermination(strStatus,
146     // msWalltime);
147   }
148
149   public void showUrl(String url)
150   {
151     showUrl(url, "jmol");
152   }
153
154   public void newJmolPopup(String menuName)
155   {
156     // jmolpopup = new JmolAwtPopup();
157     // jmolpopup.jpiInitialize((viewer), menuName);
158   }
159
160   @Override
161   public void selectionChanged(BS arg0)
162   {
163     // TODO Auto-generated method stub
164
165   }
166
167   @Override
168   public void refreshPdbEntries()
169   {
170     // TODO Auto-generated method stub
171
172   }
173
174   @Override
175   public void showConsole(boolean b)
176   {
177     appJmolWindow.showConsole(b);
178   }
179
180   @Override
181   protected JmolAppConsoleInterface createJmolConsole(
182           Container consolePanel, String buttonsToShow)
183   {
184     viewer.setJmolCallbackListener(this);
185     return new AppConsole(viewer, consolePanel, buttonsToShow);
186   }
187
188   @Override
189   protected void releaseUIResources()
190   {
191     appJmolWindow = null;
192     closeConsole();
193   }
194
195   @Override
196   public void releaseReferences(Object svl)
197   {
198     if (svl instanceof SeqPanel)
199     {
200       appJmolWindow.removeAlignmentPanel(((SeqPanel) svl).ap);
201     }
202   }
203
204   @Override
205   public Map<String, Object> getJSpecViewProperty(String arg0)
206   {
207     // TODO Auto-generated method stub
208     return null;
209   }
210 }