Merge branch 'develop' into features/JAL-2094_colourInterface

[jalview.git] / src / jalview / api / AlignViewportI.java

diff --git a/src/jalview/api/AlignViewportI.java b/src/jalview/api/AlignViewportI.java
index b4d2592..f92160e 100644 (file)
--- a/src/jalview/api/AlignViewportI.java
+++ b/src/jalview/api/AlignViewportI.java
@@ -31,7 +31,6 @@ 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;
@@ -53,6 +52,18 @@ public interface AlignViewportI extends ViewStyleI
    */
   public int calcPanelHeight();
 
+  /**
+   * Answers true if the viewport has at least one column selected
+   * 
+   * @return
+   */
+  boolean hasSelectedColumns();
+
+  /**
+   * Answers true if the viewport has at least one hidden column
+   * 
+   * @return
+   */
   boolean hasHiddenColumns();
 
   boolean isValidCharWidth();
@@ -178,10 +189,10 @@ public interface AlignViewportI extends ViewStyleI
    */
   void updateGroupAnnotationSettings(boolean applyGlobalSettings,
           boolean preserveNewGroupSettings);
-  
-  void setSequenceColour(SequenceI seq, Color col);
 
-  Color getSequenceColour(SequenceI seq);
+  void setSequenceColour(SequenceI seq, ColorI col);
+
+  ColorI getSequenceColour(SequenceI seq);
 
   void updateSequenceIdColours();
 
@@ -235,11 +246,30 @@ public interface AlignViewportI extends ViewStyleI
    * This method returns the visible alignment as text, as seen on the GUI, ie
    * if columns are hidden they will not be returned in the result. Use this for
    * calculating trees, PCA, redundancy etc on views which contain hidden
+   * columns. This method doesn't exclude hidden sequences from the output.
+   *
+   * @param selectedRegionOnly
+   *          - determines if only the selected region or entire alignment is
+   *          exported
+   * @return String[]
+   */
+  String[] getViewAsString(boolean selectedRegionOnly);
+  
+  /**
+   * This method returns the visible alignment as text, as seen on the GUI, ie
+   * if columns are hidden they will not be returned in the result. Use this for
+   * calculating trees, PCA, redundancy etc on views which contain hidden
    * columns.
    * 
+   * @param selectedRegionOnly
+   *          - determines if only the selected region or entire alignment is
+   *          exported
+   * @param isExportHiddenSeqs
+   *          - determines if hidden sequences would be exported or not.
+   * 
    * @return String[]
    */
-  String[] getViewAsString(boolean selectedRegionOnly);
+  String[] getViewAsString(boolean selectedRegionOnly, boolean isExportHiddenSeqs);
 
   void setSelectionGroup(SequenceGroup sg);
 
@@ -251,8 +281,11 @@ public interface AlignViewportI extends ViewStyleI
 
   /**
    * 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
+   * 
+   * @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);
@@ -373,8 +406,14 @@ public interface AlignViewportI extends ViewStyleI
    */
   void setFollowHighlight(boolean b);
 
-  public FeatureRenderer getFeatureRenderer();
 
-  public void setFeatureRenderer(FeatureRenderer featureRenderer);
+  public void applyFeaturesStyle(FeatureSettingsModelI featureSettings);
 
+  /**
+   * check if current selection group is defined on the view, or is simply a
+   * temporary group.
+   * 
+   * @return true if group is defined on the alignment
+   */
+  boolean isSelectionDefinedGroup();
 }