Merge branch 'develop' into releases/Release_2_11_2_Branch

[jalview.git] / src / jalview / schemes / ColourSchemeProperty.java

diff --git a/src/jalview/schemes/ColourSchemeProperty.java b/src/jalview/schemes/ColourSchemeProperty.java
index 5190c72..98e90bd 100755 (executable)
--- a/src/jalview/schemes/ColourSchemeProperty.java
+++ b/src/jalview/schemes/ColourSchemeProperty.java
@@ -20,6 +20,7 @@
  */
 package jalview.schemes;
 
+import jalview.api.AlignViewportI;
 import jalview.datamodel.AnnotatedCollectionI;
 import jalview.util.ColorUtils;
 
@@ -44,6 +45,9 @@ public class ColourSchemeProperty
    * Returns a colour scheme for the given name, with which the given data may
    * be coloured. The name is not case-sensitive, and may be one of
    * <ul>
+   * <li>any currently registered colour scheme; Jalview by default
+   * provides</li>
+   * <ul>
    * <li>Clustal</li>
    * <li>Blosum62</li>
    * <li>% Identity</li>
@@ -58,11 +62,13 @@ public class ColourSchemeProperty
    * <li>Purine/Pyrimidine</li>
    * <li>T-Coffee Scores</li>
    * <li>RNA Helices</li>
-   * <li>User Defined</li>
+   * </ul>
+   * <li>the name of a programmatically added colour scheme</li>
    * <li>an AWT colour name e.g. red</li>
    * <li>an AWT hex rgb colour e.g. ff2288</li>
    * <li>residue colours list e.g. D,E=red;K,R,H=0022FF;c=yellow</li>
    * </ul>
+   * 
    * If none of these formats is matched, the string is converted to a colour
    * using a hashing algorithm. For name "None", returns null.
    * 
@@ -70,8 +76,8 @@ public class ColourSchemeProperty
    * @param name
    * @return
    */
-  public static ColourSchemeI getColourScheme(AnnotatedCollectionI forData,
-          String name)
+  public static ColourSchemeI getColourScheme(AlignViewportI view,
+          AnnotatedCollectionI forData, String name)
   {
     if (ResidueColourScheme.NONE.equalsIgnoreCase(name))
     {
@@ -83,8 +89,8 @@ public class ColourSchemeProperty
      * if this is the name of a registered colour scheme, just
      * create a new instance of it
      */
-    ColourSchemeI scheme = ColourSchemes.getInstance().getColourScheme(
-            name, forData, null);
+    ColourSchemeI scheme = ColourSchemes.getInstance().getColourScheme(name,
+            view, forData, null);
     if (scheme != null)
     {
       return scheme;
@@ -144,8 +150,7 @@ public class ColourSchemeProperty
    */
   public static String getColourName(ColourSchemeI cs)
   {
-    return cs == null ? ResidueColourScheme.NONE : cs
-            .getSchemeName();
+    return cs == null ? ResidueColourScheme.NONE : cs.getSchemeName();
   }
 
 }