2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
3 * Copyright (C) 2014 The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.javascript;
23 import jalview.api.AlignmentViewPanel;
24 import jalview.api.FeatureRenderer;
25 import jalview.api.SequenceRenderer;
26 import jalview.appletgui.AlignFrame;
27 import jalview.bin.JalviewLite;
28 import jalview.datamodel.SequenceI;
29 import jalview.ext.jmol.JmolCommands;
30 import jalview.structure.AtomSpec;
31 import jalview.structure.StructureListener;
32 import jalview.structure.StructureMapping;
33 import jalview.structure.StructureMappingcommandSet;
34 import jalview.structure.StructureSelectionManager;
36 import java.util.ArrayList;
37 import java.util.List;
40 * Propagate events involving PDB structures associated with sequences to a
41 * javascript function. Generally, the javascript handler is called with a
42 * series of arguments like (eventname, ... ). As of Jalview 2.7, the following
43 * different types of events are supported:
45 * <li>mouseover: javascript function called with arguments
48 * ['mouseover',String(pdb file URI), String(pdb file chain ID), String(residue
49 * number moused over), String(atom index corresponding to residue)]
53 * <li>colourstruct: javascript function called with arguments
56 * ['colourstruct',String(alignment view id),String(number of javascript message
57 * chunks to collect),String(length of first chunk in set of messages - or zero
62 * The message contains a series of Jmol script commands that will colour
63 * structures according to their associated sequences in the current view. Use
65 * .javascript.JalviewLiteJsApi.getJsMessage('colourstruct',String(alignment
66 * view id)) to retrieve successive chunks of the message.</li>
69 * @author Jim Procter (jprocter)
72 public class MouseOverStructureListener extends JSFunctionExec implements
73 JsCallBack, StructureListener
80 public MouseOverStructureListener(JalviewLite jalviewLite,
81 String listener, String[] modelList)
84 _listenerfn = listener;
88 for (int i = 0; i < modelSet.length; i++)
90 // resolve a real filename
93 if (new java.net.URL(modelSet[i]).openConnection() != null)
103 String db = jvlite.getDocumentBase().toString();
104 db = db.substring(0, db.lastIndexOf("/"));
105 if (new java.net.URL(db + "/" + modelSet[i]).openConnection() != null)
107 modelSet[i] = db + "/" + modelSet[i];
110 } catch (Exception x)
116 if (new java.net.URL(jvlite.getCodeBase() + modelSet[i])
117 .openConnection() != null)
119 modelSet[i] = jvlite.getCodeBase() + modelSet[i];
122 } catch (Exception x)
132 public String[] getPdbFile()
137 public void mouseOverStructure(int atomIndex, String strInfo)
140 // StructureSelectionManager.getStructureSelectionManager().mouseOverStructure(atomIndex,
142 // TODO Auto-generated method stub
147 public void highlightAtoms(List<AtomSpec> atoms)
149 for (AtomSpec atom : atoms)
153 executeJavascriptFunction(_listenerfn, new String[]
154 { "mouseover", "" + atom.getPdbId(), "" + atom.getChain(),
155 "" + (atom.getPdbResNum()), "" + atom.getAtomIndex() });
156 } catch (Exception ex)
158 System.err.println("Couldn't execute callback with " + _listenerfn
159 + " for atomSpec: " + atom);
160 ex.printStackTrace();
166 public synchronized void updateColours(Object srce)
168 final Object source = srce;
169 StructureSelectionManager ssm = StructureSelectionManager
170 .getStructureSelectionManager(jvlite);
173 // ssm.reportMapping();
175 if (source instanceof jalview.api.AlignmentViewPanel)
177 SequenceI[][] sequence = new SequenceI[modelSet.length][];
178 for (int m = 0; m < modelSet.length; m++)
180 StructureMapping[] sm = ssm.getMapping(modelSet[m]);
181 if (sm != null && sm.length > 0)
183 sequence[m] = new SequenceI[sm.length];
184 for (int i = 0; i < sm.length; i++)
186 sequence[m][i] = sm[i].getSequence();
191 sequence[m] = new SequenceI[0];
195 // System.err.println("Mapped '" + modelSet[m] + "' to "
196 // + sequence[m].length + " sequences.");
200 SequenceRenderer sr = ((jalview.appletgui.AlignmentPanel) source)
201 .getSequenceRenderer();
202 FeatureRenderer fr = ((jalview.appletgui.AlignmentPanel) source).av
203 .getShowSequenceFeatures() ? new jalview.appletgui.FeatureRenderer(
204 ((jalview.appletgui.AlignmentPanel) source).av) : null;
207 ((jalview.appletgui.FeatureRenderer) fr)
208 .transferSettings(((jalview.appletgui.AlignmentPanel) source)
209 .getFeatureRenderer());
213 // Form a colour command from the given alignment panel for each distinct
215 ArrayList<String[]> ccomands = new ArrayList<String[]>();
216 ArrayList<String> pdbfn = new ArrayList<String>();
217 StructureMappingcommandSet[] colcommands = JmolCommands
218 .getColourBySequenceCommand(ssm, modelSet, sequence, sr, fr,
219 ((AlignmentViewPanel) source).getAlignment());
220 if (colcommands == null)
225 for (jalview.structure.StructureMappingcommandSet ccset : colcommands)
227 sz += ccset.commands.length;
228 ccomands.add(ccset.commands);
229 pdbfn.add(ccset.mapping);
232 String mclass, mhandle;
233 String ccomandset[] = new String[sz];
235 for (String[] ccset : ccomands)
237 System.arraycopy(ccset, 0, ccomandset, sz, ccset.length);
240 if (jvlite.isJsMessageSetChanged(
241 mclass = "colourstruct",
242 mhandle = ((jalview.appletgui.AlignmentPanel) source).av
243 .getViewId(), ccomandset))
245 jvlite.setJsMessageSet(mclass, mhandle, ccomandset);
246 // and notify javascript handler
247 String st[] = new String[]
250 "" + ((jalview.appletgui.AlignmentPanel) source).av.getViewId(),
251 "" + ccomandset.length,
252 jvlite.arrayToSeparatorList(pdbfn.toArray(new String[pdbfn
256 executeJavascriptFunction(true, _listenerfn, st);
257 } catch (Exception ex)
259 System.err.println("Couldn't execute callback with "
260 + _listenerfn + " using args { " + st[0] + ", " + st[1]
261 + ", " + st[2] + "," + st[3] + "}"); // + ","+st[4]+"\n");
262 ex.printStackTrace();
267 * new Thread(new Runnable() { public void run() { // and send to
268 * javascript handler String st[] = new String[0]; int i = 0; for (String
269 * colcommand : colcommands) { // do sync execution for each chunk try {
270 * executeJavascriptFunction( false, _listenerfn, st = new String[] {
271 * "colourstruct", "" + ((jalview.appletgui.AlignmentPanel) source).av
272 * .getViewId(), handle, "" }); } catch (Exception ex) {
273 * System.err.println("Couldn't execute callback with " + _listenerfn +
274 * " using args { " + st[0] + ", " + st[1] + ", " + st[2] + "," + st[3] +
275 * "\n"); ex.printStackTrace();
284 public AlignFrame getAlignFrame()
286 // associated with all alignframes, always.
291 public String getListenerFunction()
296 public void finalise()
303 public void releaseReferences(Object svl)
306 // TODO Auto-generated method stub