JAL-2805 interface comments, progress on associating leaves

[jalview.git] / src / jalview / ext / archaeopteryx / ExternalTreeViewerBindingI.java

diff --git a/src/jalview/ext/archaeopteryx/ExternalTreeViewerBindingI.java b/src/jalview/ext/archaeopteryx/ExternalTreeViewerBindingI.java
index 2bef9d6..2a807a3 100644 (file)
--- a/src/jalview/ext/archaeopteryx/ExternalTreeViewerBindingI.java
+++ b/src/jalview/ext/archaeopteryx/ExternalTreeViewerBindingI.java
@@ -29,16 +29,24 @@ import java.awt.event.MouseEvent;
 import java.awt.event.MouseListener;
 
 /**
+ * 
  * Interface for binding a tree viewer to Jalview alignments. Assumes a tree
  * viewer will both want to receive and send selection events.
  * 
  * @author kjvanderheide
  *
+ * @param <N>
+ *          Tree node object.
  */
 interface ExternalTreeViewerBindingI<N>
         extends ActionListener, MouseListener, SelectionListener,
         SelectionSource
 {
+  /**
+   * If a node is selected in the tree panel this method highlights the
+   * corresponding sequence in the Jalview alignment view. If an internal node
+   * is selected all child sequences get highlighted as well.
+   */
   public void showNodeSelectionOnAlign(MouseEvent e);
 
   public void treeSelectionChanged(SequenceI sequence);