formatting
[jalview.git] / src / jalview / structure / StructureListener.java
index 5ceefd3..e07b480 100644 (file)
@@ -21,20 +21,26 @@ public interface StructureListener
 {
   /**
    * 
-   * @return list of structure files (unique IDs/filenames) that this listener handles messages for, or null if generic listener (only used by removeListener method)
+   * @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 
+   * 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
+   * called by StructureSelectionManager to inform viewer to highlight given
+   * atomspec
+   * 
    * @param atomIndex
    * @param pdbResNum
    * @param chain
@@ -44,13 +50,17 @@ public interface StructureListener
           String pdbId);
 
   /**
-   * called by StructureSelectionManager when the colours of a sequence associated with a structure have changed.
-   * @param source (untyped) usually an alignPanel
+   * 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
@@ -61,7 +71,10 @@ public interface StructureListener
           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).
+   * 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);