JAL-2808 capture feature attributes datatype (Character/Number/Mixed) for more intell...
[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   Hydrophobic("Hydrophobic", HydrophobicColourScheme.class),
38   Helix("Helix Propensity", HelixColourScheme.class),
39   Strand("Strand Propensity", StrandColourScheme.class),
40   Turn("Turn Propensity", TurnColourScheme.class),
41   Buried("Buried Index", BuriedColourScheme.class),
42   Nucleotide("Nucleotide", NucleotideColourScheme.class),
43   PurinePyrimidine("Purine/Pyrimidine", PurinePyrimidineColourScheme.class),
44   RNAHelices("RNA Helices", RNAHelicesColour.class),
45   TCoffee("T-Coffee Scores", TCoffeeColourScheme.class);
46   // RNAInteraction("RNA Interaction type", RNAInteractionColourScheme.class)
47
48   private String name;
49
50   private Class<? extends ColourSchemeI> myClass;
51
52   /**
53    * Constructor given the name of the colour scheme (as used in Jalview
54    * parameters). Note this is not necessarily the same as the 'display name'
55    * used in menu options (as this may be language-dependent).
56    * 
57    * @param s
58    */
59   JalviewColourScheme(String s, Class<? extends ColourSchemeI> cl)
60   {
61     name = s;
62     myClass = cl;
63   }
64
65   /**
66    * Returns the class of the colour scheme
67    * 
68    * @return
69    */
70   public Class<? extends ColourSchemeI> getSchemeClass()
71   {
72     return myClass;
73   }
74
75   /**
76    * Returns the 'official' name of this colour scheme. This is the name that
77    * identifies the colour scheme as a start-up parameter for the Jalview
78    * application or applet. Note that it may not be the name shown in menu
79    * options, as these may be internationalised.
80    */
81   @Override
82   public String toString()
83   {
84     return name;
85   }
86 }