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