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   IdColour("Sequence ID", IdColourScheme.class),
  47   HMMERU("HMMER-Uniprot", HmmerGlobalBackground.class),
  48   HMMERA("HMMER-Alignment", HmmerLocalBackground.class);
  49   // RNAInteraction("RNA Interaction type", RNAInteractionColourScheme.class)
  50
  51   private String name;
  52
  53   private Class<? extends ColourSchemeI> myClass;
  54
  55   /**
  56    * Constructor given the name of the colour scheme (as used in Jalview
  57    * parameters). Note this is not necessarily the same as the 'display name'
  58    * used in menu options (as this may be language-dependent).
  59    *
  60    * @param s
  61    */
  62   JalviewColourScheme(String s, Class<? extends ColourSchemeI> cl)
  63   {
  64     name = s;
  65     myClass = cl;
  66   }
  67
  68   /**
  69    * Returns the class of the colour scheme
  70    *
  71    * @return
  72    */
  73   public Class<? extends ColourSchemeI> getSchemeClass()
  74   {
  75     return myClass;
  76   }
  77
  78   /**
  79    * Returns the 'official' name of this colour scheme. This is the name that
  80    * identifies the colour scheme as a start-up parameter for the Jalview
  81    * application or applet. Note that it may not be the name shown in menu
  82    * options, as these may be internationalised.
  83    */
  84   @Override
  85   public String toString()
  86   {
  87     return name;
  88   }
  89 }