965a26b994e988683188f4384ff05080a0d401eb
[jalview.git] / src / jalview / schemes / JalviewColourScheme.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 /**
24  * An enum with the colour schemes supported by Jalview.
25  */
26 public enum JalviewColourScheme
27 {
28   /*
29    * the order of declaration is the default order in which 
30    * items are added to Colour menus
31    */
32   Clustal("Clustal", ClustalxColourScheme.class),
33   Blosum62("Blosum62", Blosum62ColourScheme.class),
34   PID("% Identity", PIDColourScheme.class),
35   Zappo("Zappo", ZappoColourScheme.class),
36   Taylor("Taylor", TaylorColourScheme.class),
37   Flower("gecos:flower", FlowerColourScheme.class),
38   Blossom("gecos:blossom", BlossomColourScheme.class),
39   Sunset("gecos:sunset", SunsetColourScheme.class),
40   Ocean("gecos:ocean", OceanColourScheme.class),
41   Hydrophobic("Hydrophobic", HydrophobicColourScheme.class),
42   Helix("Helix Propensity", HelixColourScheme.class),
43   Strand("Strand Propensity", StrandColourScheme.class),
44   Turn("Turn Propensity", TurnColourScheme.class),
45   Buried("Buried Index", BuriedColourScheme.class),
46   Nucleotide("Nucleotide", NucleotideColourScheme.class),
47   PurinePyrimidine("Purine/Pyrimidine", PurinePyrimidineColourScheme.class),
48   RNAHelices("RNA Helices", RNAHelicesColour.class),
49   TCoffee("T-Coffee Scores", TCoffeeColourScheme.class),
50   IdColour("Sequence ID", IdColourScheme.class);
51   // RNAInteraction("RNA Interaction type", RNAInteractionColourScheme.class)
52
53   private String name;
54
55   private Class<? extends ColourSchemeI> myClass;
56
57   /**
58    * Constructor given the name of the colour scheme (as used in Jalview
59    * parameters). Note this is not necessarily the same as the 'display name'
60    * used in menu options (as this may be language-dependent).
61    * 
62    * @param s
63    */
64   JalviewColourScheme(String s, Class<? extends ColourSchemeI> cl)
65   {
66     name = s;
67     myClass = cl;
68   }
69
70   /**
71    * Returns the class of the colour scheme
72    * 
73    * @return
74    */
75   public Class<? extends ColourSchemeI> getSchemeClass()
76   {
77     return myClass;
78   }
79
80   /**
81    * Returns the 'official' name of this colour scheme. This is the name that
82    * identifies the colour scheme as a start-up parameter for the Jalview
83    * application or applet. Note that it may not be the name shown in menu
84    * options, as these may be internationalised.
85    */
86   @Override
87   public String toString()
88   {
89     return name;
90   }
91 }