Merge remote-tracking branch 'origin/tasks/JAL-3070_wsinterfaces' into alpha/JAL...

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

diff --git a/src/jalview/api/FeatureSettingsModelI.java b/src/jalview/api/FeatureSettingsModelI.java
index 28f5c77..5e910dc 100644 (file)
--- a/src/jalview/api/FeatureSettingsModelI.java
+++ b/src/jalview/api/FeatureSettingsModelI.java
@@ -20,6 +20,8 @@
  */
 package jalview.api;
 
+import jalview.datamodel.features.FeatureMatcherSetI;
+
 import java.util.Comparator;
 
 /**
@@ -60,6 +62,15 @@ public interface FeatureSettingsModelI extends Comparator<String>
   FeatureColourI getFeatureColour(String type);
 
   /**
+   * Returns any filters defined for the feature type, or null if not known
+   * 
+   * @param type
+   * @return
+   */
+
+  FeatureMatcherSetI getFeatureFilters(String type);
+
+  /**
    * Returns the transparency value, from 0 (fully transparent) to 1 (fully
    * opaque)
    * 
@@ -68,8 +79,13 @@ public interface FeatureSettingsModelI extends Comparator<String>
   float getTransparency();
 
   /**
-   * Returns -1 if feature1 'precedes' (is displayed on top of) feature 2, +1 if
-   * feature2 is on top of feature1, or 0 if we don't care
+   * Returns -1 if feature1 is displayed before (below) feature 2, +1 if
+   * feature2 is displayed after (on top of) feature1, or 0 if we don't care.
+   * 
+   * <br>
+   * Note that this is the opposite ordering to how features are displayed in
+   * the feature settings dialogue. FeatureRendererModel.setFeaturePriority
+   * takes care of converting between the two.
    * 
    * @param feature1
    * @param feature2