JAL-845 code/refactoring/tests related to linking DNA and protein
[jalview.git] / src / jalview / api / AlignViewportI.java
index 368725f..798e47e 100644 (file)
@@ -1,27 +1,26 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
+ * 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 <http://www.gnu.org/licenses/>.
+ * 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.api;
 
-import java.awt.Color;
-import java.util.Hashtable;
-import java.util.Map;
-
+import jalview.analysis.Conservation;
 import jalview.datamodel.AlignmentAnnotation;
 import jalview.datamodel.AlignmentI;
 import jalview.datamodel.AlignmentView;
@@ -32,6 +31,11 @@ import jalview.datamodel.SequenceGroup;
 import jalview.datamodel.SequenceI;
 import jalview.schemes.ColourSchemeI;
 
+import java.awt.Color;
+import java.util.Hashtable;
+import java.util.List;
+import java.util.Map;
+
 /**
  * @author jimp
  * 
@@ -184,5 +188,32 @@ public interface AlignViewportI
 
   char getGapCharacter();
 
+  void setColumnSelection(ColumnSelection cs);
+
+  void setConservation(Conservation cons);
+
+  /**
+   * get a copy of the currently visible alignment annotation
+   * @param selectedOnly if true - trim to selected regions on the alignment
+   * @return an empty list or new alignment annotation objects shown only visible columns trimmed to selected region only
+   */
+  List<AlignmentAnnotation> getVisibleAlignmentAnnotation(
+          boolean selectedOnly);
+
+  /**
+   * Returns a viewport which holds the cDna for this (protein), or vice versa,
+   * or null if none is set.
+   * 
+   * @return
+   */
+  AlignViewportI getCodingComplement();
 
+  void setCodingComplement(AlignViewportI sl);
+
+  /**
+   * Answers true if viewport hosts DNA/RAN, false if peptide.
+   * 
+   * @return
+   */
+  boolean isNucleotide();
 }