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