JAL-2360 added UserColourScheme.toAppletParameter+test, hid
[jalview.git] / src / jalview / schemes / ColourSchemeProperty.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.schemes;
22
23 import jalview.datamodel.AnnotatedCollectionI;
24 import jalview.util.ColorUtils;
25
26 import java.awt.Color;
27
28 /**
29  * ColourSchemeProperty binds names to hardwired colourschemes and tries to deal
30  * intelligently with mapping unknown names to user defined colourschemes (that
31  * exist or can be created from the string representation of the colourscheme
32  * name - either a hex RGB triplet or a named colour under java.awt.color ). The
33  * values of the colourscheme constants is important for callers of
34  * getColourName(int i), since it can be used to enumerate the set of built in
35  * colours. The FIRST_COLOUR and LAST_COLOUR symbols are provided for this.
36  * 
37  * @author $author$
38  * @version $Revision$
39  */
40 public class ColourSchemeProperty
41 {
42
43   /**
44    * Returns a colour scheme for the given name, with which the given data may
45    * be coloured. The name is not case-sensitive, and may be one of
46    * <ul>
47    * <li>Clustal</li>
48    * <li>Blosum62</li>
49    * <li>% Identity</li>
50    * <li>Hydrophobic</li>
51    * <li>Zappo</li>
52    * <li>Taylor</li>
53    * <li>Helix Propensity</li>
54    * <li>Strand Propensity</li>
55    * <li>Turn Propensity</li>
56    * <li>Buried Index</li>
57    * <li>Nucleotide</li>
58    * <li>Purine/Pyrimidine</li>
59    * <li>T-Coffee Scores</li>
60    * <li>RNA Helices</li>
61    * <li>User Defined</li>
62    * <li>an AWT colour name e.g. red</li>
63    * <li>an AWT hex rgb colour e.g. ff2288</li>
64    * <li>residue colours list e.g. D,E=red;K,R,H=0022FF;c=yellow</li>
65    * </ul>
66    * If none of these formats is matched, the string is converted to a colour
67    * using a hashing algorithm. For name "None", returns null.
68    * 
69    * @param forData
70    * @param name
71    * @return
72    */
73   public static ColourSchemeI getColourScheme(AnnotatedCollectionI forData,
74           String name)
75   {
76     if (ResidueColourScheme.NONE.equalsIgnoreCase(name))
77     {
78       return null;
79
80     }
81     JalviewColourScheme scheme = JalviewColourScheme.forName(name);
82     if (scheme != null)
83     {
84       return scheme.getColourScheme(forData);
85     }
86
87     /*
88      * try to parse the string as a residues colour scheme
89      * e.g. A=red;T,G=blue etc
90      * else parse the name as a colour specification
91      * e.g. "red" or "ff00ed",
92      * or failing that hash the name to a colour
93      */
94     UserColourScheme ucs = null;
95     try
96     {
97       ucs = new UserColourScheme(name);
98     } catch (Exception e)
99     {
100       // System.err.println("Ignoring exception when parsing colourscheme as applet-parameter");
101     }
102     return ucs;
103   }
104
105   public static Color rnaHelices[] = null;
106
107   public static void initRnaHelicesShading(int n)
108   {
109     int j = 0;
110     if (rnaHelices == null)
111     {
112       rnaHelices = new Color[n + 1];
113     }
114     else if (rnaHelices != null && rnaHelices.length <= n)
115     {
116       Color[] t = new Color[n + 1];
117       System.arraycopy(rnaHelices, 0, t, 0, rnaHelices.length);
118       j = rnaHelices.length;
119       rnaHelices = t;
120     }
121     else
122     {
123       return;
124     }
125     // Generate random colors and store
126     for (; j <= n; j++)
127     {
128       rnaHelices[j] = ColorUtils.generateRandomColor(Color.white);
129     }
130   }
131
132   /**
133    * delete the existing cached RNA helices colours
134    */
135   public static void resetRnaHelicesShading()
136   {
137     rnaHelices = null;
138   }
139
140   /**
141    * Returns the name of the colour scheme (or "None" if it is null)
142    * 
143    * @param cs
144    * @return
145    */
146   public static String getColourName(ColourSchemeI cs)
147   {
148     return cs == null ? ResidueColourScheme.NONE : cs
149             .getSchemeName();
150   }
151
152 }