* ColourSchemeProperty Binds names to hardwired colourschemes and tries to deal
* intelligently with mapping unknown names to user defined colourschemes (that
* exist or can be created from the string representation of the colourscheme
- * name - either a hex RGB triplet or a named colour under java.awt.color )
+ * name - either a hex RGB triplet or a named colour under java.awt.color ). The
+ * values of the colourscheme constants is important for callers of
+ * getColourName(int i), since it can be used to enumerate the set of built in
+ * colours. The FIRST_COLOUR and LAST_COLOUR symbols are provided for this.
*
* @author $author$
* @version $Revision$
*/
public class ColourSchemeProperty
{
- /** DOCUMENT ME!! */
- public static final int CLUSTAL = 0;
+ /** Undefined Colourscheme Index */
+ public static final int UNDEFINED = -1;
+
+ /** for schemes defined on the fly */
+ public static final int USER_DEFINED = 0;
+
+ /** No Colourscheme Index */
+ public static final int NONE = 1;
/** DOCUMENT ME!! */
- public static final int BLOSUM = 1;
+ public static final int CLUSTAL = 2;
/** DOCUMENT ME!! */
- public static final int PID = 2;
+ public static final int BLOSUM = 3;
/** DOCUMENT ME!! */
- public static final int ZAPPO = 3;
+ public static final int PID = 4;
/** DOCUMENT ME!! */
- public static final int TAYLOR = 4;
+ public static final int ZAPPO = 5;
/** DOCUMENT ME!! */
- public static final int HYDROPHOBIC = 5;
+ public static final int TAYLOR = 6;
/** DOCUMENT ME!! */
- public static final int HELIX = 6;
+ public static final int HYDROPHOBIC = 7;
/** DOCUMENT ME!! */
- public static final int STRAND = 7;
+ public static final int HELIX = 8;
/** DOCUMENT ME!! */
- public static final int TURN = 8;
+ public static final int STRAND = 9;
/** DOCUMENT ME!! */
- public static final int BURIED = 9;
+ public static final int TURN = 10;
/** DOCUMENT ME!! */
- public static final int NUCLEOTIDE = 10;
+ public static final int BURIED = 11;
/** DOCUMENT ME!! */
- public static final int USER_DEFINED = 11;
+ public static final int NUCLEOTIDE = 12;
- /** No Colourscheme Index */
- public static final int NONE = 12;
+ /**
+ * purine/pyrimidine
+ */
+ public static final int PURINEPYRIMIDINE = 13;
- /** Undefined Colourscheme Index */
- public static final int UNDEFINED = 13;
+ public static final int COVARIATION = 14;
+
+ /**
+ * index of first colourscheme (includes 'None')
+ */
+ public static final int FIRST_COLOUR = NONE;
+
+ public static final int LAST_COLOUR = NUCLEOTIDE;
/**
* DOCUMENT ME!