X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=inline;f=src%2Fjalview%2Fstructure%2FStructureListener.java;h=2364549b3c987bc4e90482ff586928120c55300e;hb=c6c94d2adb0d156345065b1a7e18e26c7b8dd2b8;hp=0d7819ee2446bf763739d8863a780db2c326ff57;hpb=6905363d02254a557f93f66a2b69d85aa0b23696;p=jalview.git
diff --git a/src/jalview/structure/StructureListener.java b/src/jalview/structure/StructureListener.java
index 0d7819e..2364549 100644
--- a/src/jalview/structure/StructureListener.java
+++ b/src/jalview/structure/StructureListener.java
@@ -1,30 +1,69 @@
-/*
- * Jalview - A Sequence Alignment Editor and Viewer
- * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
- *
- * This program 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 2
- * of the License, or (at your option) any later version.
- *
- * This program 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 this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
- */
-package jalview.structure;
-
-public interface StructureListener
-{
- public String getPdbFile();
-
- public void mouseOverStructure(int atomIndex, String strInfo);
-
- public void highlightAtom(int atomIndex, int pdbResNum, String chain, String pdbId);
-
- public void updateColours(Object source);
-}
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ 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 .
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.structure;
+
+import java.util.List;
+
+import jalview.datamodel.SequenceI;
+
+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 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);
+}