JAL-2089 patch broken merge to master for Release 2.10.0b1

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

diff --git a/src/jalview/structure/VamsasListener.java b/src/jalview/structure/VamsasListener.java
index 4161676..c328c43 100644 (file)
--- a/src/jalview/structure/VamsasListener.java
+++ b/src/jalview/structure/VamsasListener.java
@@ -1,25 +1,41 @@
-/*\r
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)\r
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
- * \r
- * This file is part of Jalview.\r
- * \r
- * Jalview 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 3 of the License, or (at your option) any later version.\r
- * \r
- * Jalview is distributed in the hope that it will be useful, but \r
- * WITHOUT ANY WARRANTY; without even the implied warranty \r
- * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
- * PURPOSE.  See the GNU General Public License for more details.\r
- * \r
- * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
- */\r
-package jalview.structure;\r
-\r
-import jalview.datamodel.SequenceI;\r
-\r
-public interface VamsasListener\r
-{\r
-  public void mouseOver(SequenceI seq, int index);\r
-}\r
+/*
+ * 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 <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.structure;
+
+import jalview.datamodel.SequenceI;
+
+/**
+ * The vamsasListener allows peers to receive mouseOver events from any Jalview
+ * alignment window.
+ * 
+ * @author JimP
+ * 
+ * @history Version 1 released for Jalview 2.4.
+ * @history Version 2 mouseOver refactored to include an additional parameter
+ *          allowing the source of the event to be passed to the handler.
+ * 
+ * 
+ */
+public interface VamsasListener
+{
+  public void mouseOverSequence(SequenceI seq, int index,
+          VamsasSource source);
+}