Formatting changes
[jalview.git] / src / jalview / schemes / ColourSchemeProperty.java
index 0d5ecc7..d27dcf0 100755 (executable)
 */\r
 package jalview.schemes;\r
 \r
-public class ColourSchemeProperty {\r
+import java.awt.*;\r
+/**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @author $author$\r
+ * @version $Revision$\r
+ */\r
+public class ColourSchemeProperty\r
+{\r
+    /** DOCUMENT ME!! */\r
     public static final int CLUSTAL = 0;\r
+\r
+    /** DOCUMENT ME!! */\r
     public static final int BLOSUM = 1;\r
+\r
+    /** DOCUMENT ME!! */\r
     public static final int PID = 2;\r
+\r
+    /** DOCUMENT ME!! */\r
     public static final int ZAPPO = 3;\r
+\r
+    /** DOCUMENT ME!! */\r
     public static final int HYDROPHOBIC = 4;\r
+\r
+    /** DOCUMENT ME!! */\r
     public static final int HELIX = 5;\r
+\r
+    /** DOCUMENT ME!! */\r
     public static final int STRAND = 6;\r
+\r
+    /** DOCUMENT ME!! */\r
     public static final int TURN = 7;\r
+\r
+    /** DOCUMENT ME!! */\r
     public static final int BURIED = 8;\r
+\r
+    /** DOCUMENT ME!! */\r
     public static final int NUCLEOTIDE = 9;\r
+\r
+    /** DOCUMENT ME!! */\r
     public static final int USER_DEFINED = 10;\r
+\r
+    /** DOCUMENT ME!! */\r
     public static final int NONE = 11;\r
 \r
-    public static int getColourIndexFromName(String name) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param name DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public static int getColourIndexFromName(String name)\r
+    {\r
         int ret = 11;\r
 \r
-        if (name.equalsIgnoreCase("Clustal")) {\r
+        if (name.equalsIgnoreCase("Clustal"))\r
+        {\r
             ret = CLUSTAL;\r
-        } else if (name.equalsIgnoreCase("Blosum62")) {\r
+        }\r
+        else if (name.equalsIgnoreCase("Blosum62"))\r
+        {\r
             ret = BLOSUM;\r
-        } else if (name.equalsIgnoreCase("% Identity")) {\r
+        }\r
+        else if (name.equalsIgnoreCase("% Identity"))\r
+        {\r
             ret = PID;\r
-        } else if (name.equalsIgnoreCase("Zappo")) {\r
+        }\r
+        else if (name.equalsIgnoreCase("Zappo"))\r
+        {\r
             ret = ZAPPO;\r
-        } else if (name.equalsIgnoreCase("Hydrophobic")) {\r
+        }\r
+        else if (name.equalsIgnoreCase("Hydrophobic"))\r
+        {\r
             ret = HYDROPHOBIC;\r
-        } else if (name.equalsIgnoreCase("Helix Propensity")) {\r
+        }\r
+        else if (name.equalsIgnoreCase("Helix Propensity"))\r
+        {\r
             ret = HELIX;\r
-        } else if (name.equalsIgnoreCase("Strand Propensity")) {\r
+        }\r
+        else if (name.equalsIgnoreCase("Strand Propensity"))\r
+        {\r
             ret = STRAND;\r
-        } else if (name.equalsIgnoreCase("Turn Propensity")) {\r
+        }\r
+        else if (name.equalsIgnoreCase("Turn Propensity"))\r
+        {\r
             ret = TURN;\r
-        } else if (name.equalsIgnoreCase("Buried Index")) {\r
+        }\r
+        else if (name.equalsIgnoreCase("Buried Index"))\r
+        {\r
             ret = BURIED;\r
-        } else if (name.equalsIgnoreCase("Nucleotide")) {\r
+        }\r
+        else if (name.equalsIgnoreCase("Nucleotide"))\r
+        {\r
             ret = NUCLEOTIDE;\r
-        } else if (name.equalsIgnoreCase("User Defined")) {\r
+        }\r
+        else if (name.equalsIgnoreCase("User Defined"))\r
+        {\r
             ret = USER_DEFINED;\r
         }\r
 \r
         return ret;\r
     }\r
 \r
-    public static String getColourName(ColourSchemeI cs) {\r
-        if (cs instanceof ConservationColourScheme) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param cs DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public static String getColourName(ColourSchemeI cs)\r
+    {\r
+        if (cs instanceof ConservationColourScheme)\r
+        {\r
             cs = ((ConservationColourScheme) cs).cs;\r
         }\r
 \r
         int index = 11;\r
 \r
-        if (cs instanceof ClustalxColourScheme) {\r
+        if (cs instanceof ClustalxColourScheme)\r
+        {\r
             index = CLUSTAL;\r
-        } else if (cs instanceof Blosum62ColourScheme) {\r
+        }\r
+        else if (cs instanceof Blosum62ColourScheme)\r
+        {\r
             index = BLOSUM;\r
-        } else if (cs instanceof PIDColourScheme) {\r
+        }\r
+        else if (cs instanceof PIDColourScheme)\r
+        {\r
             index = PID;\r
-        } else if (cs instanceof ZappoColourScheme) {\r
+        }\r
+        else if (cs instanceof ZappoColourScheme)\r
+        {\r
             index = ZAPPO;\r
-        } else if (cs instanceof HydrophobicColourScheme) {\r
+        }\r
+        else if (cs instanceof HydrophobicColourScheme)\r
+        {\r
             index = HYDROPHOBIC;\r
-        } else if (cs instanceof HelixColourScheme) {\r
+        }\r
+        else if (cs instanceof HelixColourScheme)\r
+        {\r
             index = HELIX;\r
-        } else if (cs instanceof StrandColourScheme) {\r
+        }\r
+        else if (cs instanceof StrandColourScheme)\r
+        {\r
             index = STRAND;\r
-        } else if (cs instanceof TurnColourScheme) {\r
+        }\r
+        else if (cs instanceof TurnColourScheme)\r
+        {\r
             index = TURN;\r
-        } else if (cs instanceof BuriedColourScheme) {\r
+        }\r
+        else if (cs instanceof BuriedColourScheme)\r
+        {\r
             index = BURIED;\r
-        } else if (cs instanceof NucleotideColourScheme) {\r
+        }\r
+        else if (cs instanceof NucleotideColourScheme)\r
+        {\r
             index = NUCLEOTIDE;\r
-        } else if (cs instanceof UserColourScheme) {\r
+        }\r
+        else if (cs instanceof UserColourScheme)\r
+        {\r
             index = USER_DEFINED;\r
         }\r
 \r
         return getColourName(index);\r
     }\r
 \r
-    public static String getColourName(int index) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param index DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public static String getColourName(int index)\r
+    {\r
         String ret = null;\r
 \r
-        switch (index) {\r
+        switch (index)\r
+        {\r
         case CLUSTAL:\r
             ret = "Clustal";\r
 \r
@@ -164,21 +263,51 @@ public class ColourSchemeProperty {
         return ret;\r
     }\r
 \r
-    public static ColourSchemeI getColour(jalview.datamodel.AlignmentI al, String name)\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param al DOCUMENT ME!\r
+     * @param name DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public static ColourSchemeI getColour(jalview.datamodel.AlignmentI al,\r
+        String name)\r
     {\r
-     return getColour(al.getSequences(), al.getWidth(), name);\r
+        return getColour(al.getSequences(), al.getWidth(), name);\r
     }\r
 \r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param seqs DOCUMENT ME!\r
+     * @param width DOCUMENT ME!\r
+     * @param name DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
     public static ColourSchemeI getColour(java.util.Vector seqs, int width,\r
-        String name) {\r
+        String name)\r
+    {\r
         return getColour(seqs, width, getColourIndexFromName(name));\r
     }\r
 \r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param seqs DOCUMENT ME!\r
+     * @param width DOCUMENT ME!\r
+     * @param index DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
     public static ColourSchemeI getColour(java.util.Vector seqs, int width,\r
-        int index) {\r
+        int index)\r
+    {\r
         ColourSchemeI cs = null;\r
 \r
-        switch (index) {\r
+        switch (index)\r
+        {\r
         case CLUSTAL:\r
             cs = new ClustalxColourScheme(seqs, width);\r
 \r
@@ -230,7 +359,7 @@ public class ColourSchemeProperty {
             break;\r
 \r
         case USER_DEFINED:\r
-            cs = new UserColourScheme(null);\r
+            cs = new UserColourScheme(new Color[0]);\r
 \r
             break;\r
 \r
@@ -240,4 +369,38 @@ public class ColourSchemeProperty {
 \r
         return cs;\r
     }\r
+\r
+    public static Color getAWTColorFromName(String name)\r
+    {\r
+      Color col = null;\r
+      name = name.toLowerCase();\r
+      if(name.equals("black"))\r
+        col = Color.black;\r
+      else if(name.equals("blue"))\r
+        col = Color.blue;\r
+      else if(name.equals("cyan"))\r
+        col = Color.cyan;\r
+      else if(name.equals("darkGray"))\r
+        col = Color.darkGray;\r
+      else if(name.equals("gray"))\r
+        col = Color.gray;\r
+      else if(name.equals("green"))\r
+        col = Color.green;\r
+      else if(name.equals("lightGray"))\r
+        col = Color.lightGray;\r
+      else if(name.equals("magenta"))\r
+        col = Color.magenta;\r
+      else if(name.equals("orange"))\r
+        col = Color.orange;\r
+      else if(name.equals("pink"))\r
+        col = Color.pink;\r
+      else if(name.equals("red"))\r
+        col = Color.red;\r
+      else if(name.equals("white"))\r
+        col = Color.white;\r
+      else if(name.equals("yellow"))\r
+        col = Color.yellow;\r
+\r
+      return col;\r
+    }\r
 }\r