X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fstructure%2FStructureListener.java;h=c2d1ecb7d8bb02d0bae7b09ae76f8dd0ba00b47d;hb=a45774ee31d9f35d4eff46d54d7deab719afb092;hp=940a782ef3e2ebcbcecf812afdd0ec8984c90755;hpb=d423f22792e47dbc800ae220a58677f988971d06;p=jalview.git

diff --git a/src/jalview/structure/StructureListener.java b/src/jalview/structure/StructureListener.java
index 940a782..c2d1ecb 100644
--- a/src/jalview/structure/StructureListener.java
+++ b/src/jalview/structure/StructureListener.java
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
  * 
  * This file is part of Jalview.
  * 
@@ -19,15 +19,50 @@ package jalview.structure;
 
 public interface StructureListener
 {
-  public String getPdbFile();
+  /**
+   * 
+   * @return list of structure files (unique IDs/filenames) that this listener handles messages for, or null if generic listener (only used by removeListener method)
+   */
+  public String[] getPdbFile();
 
+  /**
+   * NOT A LISTENER METHOD!
+   * called by structure viewer when the given atom/structure has been moused over. Typically, implementors call StructureSelectionManager.mouseOverStructure 
+   * @param atomIndex
+   * @param strInfo
+   */
   public void mouseOverStructure(int atomIndex, String strInfo);
 
+  /**
+   * called by StructureSelectionManager to inform viewer to highlight given atomspec
+   * @param atomIndex
+   * @param pdbResNum
+   * @param chain
+   * @param pdbId
+   */
   public void highlightAtom(int atomIndex, int pdbResNum, String chain,
           String pdbId);
 
+  /**
+   * called by StructureSelectionManager when the colours of a sequence associated with a structure have changed.
+   * @param source (untyped) usually an alignPanel
+   */
   public void updateColours(Object source);
 
+  /**
+   * called by Jalview to get the colour for the given atomspec
+   * @param atomIndex
+   * @param pdbResNum
+   * @param chain
+   * @param pdbId
+   * @return
+   */
   public java.awt.Color getColour(int atomIndex, int pdbResNum,
           String chain, String pdbId);
+
+  /**
+   * called by structureSelectionManager to instruct implementor to release any direct references it may hold to the given object (typically, these are Jalview alignment panels).
+   * @param svl
+   */
+  public void releaseReferences(Object svl);
 }