JAL-2388 First move of endRes etc out of AlignmentViewport (in progress)
[jalview.git] / src / jalview / api / AlignViewportI.java
index ee03852..6cdc998 100644 (file)
@@ -31,8 +31,9 @@ import jalview.datamodel.SearchResultsI;
 import jalview.datamodel.SequenceCollectionI;
 import jalview.datamodel.SequenceGroup;
 import jalview.datamodel.SequenceI;
-import jalview.schemes.CollectionColourSchemeI;
+import jalview.renderer.ResidueShaderI;
 import jalview.schemes.ColourSchemeI;
+import jalview.viewmodel.ViewportPositionProps;
 
 import java.awt.Color;
 import java.util.Hashtable;
@@ -46,8 +47,12 @@ import java.util.Map;
 public interface AlignViewportI extends ViewStyleI
 {
 
+  ViewportPositionProps getPosProps();
+  
   int getEndRes();
 
+  int getStartRes();
+
   /**
    * calculate the height for visible annotation, revalidating bounds where
    * necessary ABSTRACT GUI METHOD
@@ -80,7 +85,13 @@ public interface AlignViewportI extends ViewStyleI
 
   ColourSchemeI getGlobalColourScheme();
 
-  CollectionColourSchemeI getViewportColourScheme();
+  /**
+   * Returns an object that describes colouring (including any thresholding or
+   * fading) of the alignment
+   * 
+   * @return
+   */
+  ResidueShaderI getResidueShading();
 
   AlignmentI getAlignment();
 
@@ -160,7 +171,7 @@ public interface AlignViewportI extends ViewStyleI
 
   /**
    * 
-   * @return the alignment annotatino row for the structure consensus
+   * @return the alignment annotation row for the structure consensus
    *         calculation
    */
   AlignmentAnnotation getAlignmentStrucConsensusAnnotation();
@@ -173,11 +184,13 @@ public interface AlignViewportI extends ViewStyleI
   void setRnaStructureConsensusHash(Hashtable[] hStrucConsensus);
 
   /**
-   * set global colourscheme
+   * Sets the colour scheme for the background alignment (as distinct from
+   * sub-groups, which may have their own colour schemes). A null value is used
+   * for no residue colour (white).
    * 
-   * @param rhc
+   * @param cs
    */
-  void setGlobalColourScheme(ColourSchemeI rhc);
+  void setGlobalColourScheme(ColourSchemeI cs);
 
   Map<SequenceI, SequenceCollectionI> getHiddenRepSequences();
 
@@ -448,4 +461,8 @@ public interface AlignViewportI extends ViewStyleI
    * @return search results or null
    */
   SearchResultsI getSearchResults();
+
+  int getStartSeq();
+
+  int getEndSeq();
 }