JAL-3148 SequenceRenderer, ResidueColourFinder overloads and
[jalview.git] / src / jalview / appletgui / AppletJmolBinding.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.api.AlignmentViewPanel;
24 import jalview.datamodel.PDBEntry;
25 import jalview.datamodel.SequenceI;
26 import jalview.ext.jmol.JalviewJmolBinding;
27 import jalview.gui.IProgressIndicator;
28 import jalview.io.DataSourceType;
29 import jalview.structure.StructureSelectionManager;
30
31 import java.awt.Container;
32 import java.util.Map;
33
34 import org.jmol.api.JmolAppConsoleInterface;
35 import org.jmol.console.AppletConsole;
36 import org.jmol.java.BS;
37
38 class AppletJmolBinding extends JalviewJmolBinding
39 {
40
41   /**
42    * Window that contains the bound Jmol instance
43    */
44   private AppletJmol appletJmolBinding;
45
46   public AppletJmolBinding(AppletJmol appletJmol,
47           StructureSelectionManager sSm, PDBEntry[] pdbentry,
48           SequenceI[][] seq, DataSourceType protocol)
49   {
50     super(sSm, pdbentry, seq, protocol);
51     appletJmolBinding = appletJmol;
52   }
53
54   @Override
55   public jalview.api.FeatureRenderer getFeatureRenderer(
56           AlignmentViewPanel alignment)
57   {
58     return appletJmolBinding.ap.getFeatureRenderer();
59   }
60
61   @Override
62   public void sendConsoleEcho(String strEcho)
63   {
64     if (appletJmolBinding.scriptWindow == null)
65     {
66       appletJmolBinding.showConsole(true);
67     }
68
69     appletJmolBinding.addToHistory(strEcho);
70   }
71
72   @Override
73   public void sendConsoleMessage(String strStatus)
74   {
75     if (appletJmolBinding.history != null && strStatus != null
76             && !strStatus.equals("Script completed"))
77     {
78       appletJmolBinding.addToHistory(strStatus);
79     }
80   }
81
82   @Override
83   public void showUrl(String url, String target)
84   {
85     appletJmolBinding.ap.alignFrame.showURL(url, target);
86
87   }
88
89   @Override
90   public void refreshGUI()
91   {
92     appletJmolBinding.updateTitleAndMenus();
93   }
94
95   @Override
96   public void updateColours(Object source)
97   {
98     AlignmentPanel ap = (AlignmentPanel) source;
99     colourBySequence(ap);
100   }
101
102   @Override
103   public void showUrl(String url)
104   {
105     try
106     {
107       appletJmolBinding.ap.av.applet.getAppletContext()
108               .showDocument(new java.net.URL(url), "jmol");
109     } catch (java.net.MalformedURLException ex)
110     {
111     }
112   }
113
114   public void newJmolPopup(boolean translateLocale, String menuName,
115           boolean asPopup)
116   {
117     // jmolpopup = new JmolAwtPopup(); // is this used?
118     // jmolpopup.jpiInitialize((viewer), menuName);
119   }
120
121   @Override
122   public void notifyScriptTermination(String strStatus, int msWalltime)
123   {
124     // do nothing.
125   }
126
127   @Override
128   public void selectionChanged(BS arg0)
129   {
130     // TODO Auto-generated method stub
131
132   }
133
134   @Override
135   public void refreshPdbEntries()
136   {
137     // noop
138   }
139
140   @Override
141   public void showConsole(boolean show)
142   {
143     appletJmolBinding.showConsole(show);
144   }
145
146   @Override
147   protected JmolAppConsoleInterface createJmolConsole(
148           Container consolePanel, String buttonsToShow)
149   {
150     JmolAppConsoleInterface appc = new AppletConsole();
151     appc.start(viewer);
152     return appc;
153   }
154
155   @Override
156   protected void releaseUIResources()
157   {
158     appletJmolBinding = null;
159     closeConsole();
160   }
161
162   @Override
163   public void releaseReferences(Object svl)
164   {
165   }
166
167   @Override
168   public int[] resizeInnerPanel(String data)
169   {
170     // TODO Auto-generated method stub
171     return null;
172   }
173
174   @Override
175   public Map<String, Object> getJSpecViewProperty(String arg0)
176   {
177     // TODO Auto-generated method stub
178     return null;
179   }
180
181   @Override
182   protected IProgressIndicator getIProgressIndicator()
183   {
184     // no progress indicators on the applet
185     return null;
186   }
187 }