From: jprocter <jprocter@compbio.dundee.ac.uk>
Date: Sun, 3 Jul 2011 12:42:29 +0000 (+0100)
Subject: documentation (JAL-859, JAL-816, JAL-621)
X-Git-Tag: Release_2_7~160
X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=fb919eea777481decc7873efacbefbaf5bb0f05a;p=jalview.git

documentation (JAL-859, JAL-816, JAL-621)
---

diff --git a/src/jalview/javascript/MouseOverStructureListener.java b/src/jalview/javascript/MouseOverStructureListener.java
index c1d3a40..41af88e 100644
--- a/src/jalview/javascript/MouseOverStructureListener.java
+++ b/src/jalview/javascript/MouseOverStructureListener.java
@@ -12,6 +12,29 @@ import jalview.structure.StructureListener;
 import jalview.structure.StructureMapping;
 import jalview.structure.StructureSelectionManager;
 
+/**
+ * Propagate events involving PDB structures associated with sequences to a
+ * javascript function. Generally, the javascript handler is called with a
+ * series of arguments like (eventname, ... ). As of Jalview 2.7, the following
+ * different types of events are supported:
+ * <ul>
+ * <li>mouseover: javascript function called with arguments <pre>
+ * ['mouseover',String(pdb file URI), String(pdb file chain ID), String(residue
+ * number moused over), String(atom index corresponding to residue)]</pre></li>
+ * <li>colourstruct: javascript function called with arguments <pre>
+ * ['colourstruct',String(alignment view id),String(number of javascript message
+ * chunks to collect),String(length of first chunk in set of messages - or zero
+ * for null message)]</pre><br>
+ * The message contains a series of Jmol script commands that will colour
+ * structures according to their associated sequences in the current view. Use
+ * jalview
+ * .javascript.JalviewLiteJsApi.getJsMessage('colourstruct',String(alignment
+ * view id)) to retrieve successive chunks of the message.</li>
+ * </ul>
+ * 
+ * @author Jim Procter (jprocter)
+ * 
+ */
 public class MouseOverStructureListener extends JSFunctionExec implements
         JsCallBack, StructureListener
 {