JAL-1925 update source version in license

[jalview.git] / src / jalview / structure / StructureListener.java

diff --git a/src/jalview/structure/StructureListener.java b/src/jalview/structure/StructureListener.java
index 5436eae..8055d24 100644 (file)
--- a/src/jalview/structure/StructureListener.java
+++ b/src/jalview/structure/StructureListener.java
@@ -1,32 +1,69 @@
-/*\r
- * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
- *\r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
- */\r
-package jalview.structure;\r
-\r
-public interface StructureListener\r
-{\r
-  public String getPdbFile();\r
-\r
-  public void mouseOverStructure(int atomIndex, String strInfo);\r
-\r
-  public void highlightAtom(int atomIndex, int pdbResNum, String chain, String pdbId);\r
-\r
-  public void updateColours(Object source);\r
-\r
-  public java.awt.Color getColour(int atomIndex, int pdbResNum, String chain, String pdbId);\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9.0b2)
+ * Copyright (C) 2015 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.
+ *  
+ * 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 <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.structure;
+
+import jalview.datamodel.SequenceI;
+
+import java.util.List;
+
+public interface StructureListener
+{
+  /**
+   * Returns a 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();
+
+  /**
+   * Called by StructureSelectionManager to inform viewer to highlight given
+   * atom positions
+   * 
+   * @param atoms
+   */
+  public void highlightAtoms(List<AtomSpec> atoms);
+
+  /**
+   * 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 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);
+
+  /**
+   * Answers true if this listener is interested in the given sequence
+   * 
+   * @param seq
+   * @return
+   */
+  public boolean isListeningFor(SequenceI seq);
+}