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