JAL-1160 support horizontal mouse wheel scrolling events
[jalview.git] / src / jalview / datamodel / SequenceI.java
index a1a7bc2..186156d 100755 (executable)
@@ -1,6 +1,6 @@
 /*
- * 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.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
  * 
  * This file is part of Jalview.
  * 
@@ -17,7 +17,7 @@
  */
 package jalview.datamodel;
 
-import java.util.*;
+import java.util.Vector;
 
 /**
  * DOCUMENT ME!
@@ -164,12 +164,15 @@ public interface SequenceI
   public String getDescription();
 
   /**
-   * DOCUMENT ME!
+   * Return the alignment column for a sequence position
+   *    * Return the alignment position for a sequence position
    * 
    * @param pos
-   *          DOCUMENT ME!
+   *          lying from start to end
+   * 
+   * @return aligned column for residue (0 if residue is upstream from alignment, -1 if residue is downstream from alignment)
+   * note. Sequence object returns sequence.getEnd() for positions upstream currently. TODO: change sequence for assert(findIndex(seq.getEnd()+1)==-1) and fix incremental bugs
    * 
-   * @return DOCUMENT ME!
    */
   public int findIndex(int pos);
 
@@ -348,5 +351,15 @@ public interface SequenceI
    *          null or mapping from entry's numbering to local start/end
    */
   public void transferAnnotation(SequenceI entry, Mapping mp);
+  
+  /**
+   * @param index The sequence index in the MSA 
+   */
+  public void setIndex(int index);
+  
+  /**
+   * @return The index of the sequence in the alignment
+   */
+  public int getIndex();
 
 }