X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fstructure%2FStructureListener.java;h=8ac002b2332c2a56bbed9194b6b7980d33d92e53;hb=2cbc2e45a74eb8cf8040f9a71636289ca2db5241;hp=4ad4405ed29cf3a67a76cf892f6c22676b6a651a;hpb=d038c9702429f76a1556c7d2b282f26d9feb22f6;p=jalview.git
diff --git a/src/jalview/structure/StructureListener.java b/src/jalview/structure/StructureListener.java
index 4ad4405..8ac002b 100644
--- a/src/jalview/structure/StructureListener.java
+++ b/src/jalview/structure/StructureListener.java
@@ -1,19 +1,22 @@
/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
+ * Copyright (C) 2014 The Jalview Authors
*
* This file is part of Jalview.
*
* Jalview is free software: you can redistribute it and/or
* modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
- *
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
* Jalview is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU General Public License for more details.
*
- * You should have received a copy of the GNU General Public License along with Jalview. If not, see .
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see .
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
*/
package jalview.structure;
@@ -21,20 +24,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 +53,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
@@ -59,4 +72,13 @@ public interface StructureListener
*/
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);
}