*/
package jalview.datamodel;
-import java.awt.*;
+import java.awt.Color;
/**
- * DOCUMENT ME!
+ * Holds all annotation values for a position in an AlignmentAnnotation row
*
* @author $author$
* @version $Revision$
*/
public class Annotation
{
- /** DOCUMENT ME!! */
+ /** Character label - also shown below histogram */
public String displayCharacter = "";
- /** DOCUMENT ME!! */
- public String description = ""; // currently used as mouse over
+ /**
+ * Text label for position: shown in mouse over and displayed on secondary
+ * structure glyphs
+ */
+ public String description = "";
- /** DOCUMENT ME!! */
- public char secondaryStructure = ' '; // recognises H, E and S(?)
+ /**
+ * Secondary structure symbol: Protein symbols are H, E and S(?), RNA are
+ * WUSS/Vienna plus extended pseudoknot symbols
+ */
+ public char secondaryStructure = ' ';
- /** DOCUMENT ME!! */
+ /** Score for the position - used in histograms, line graphs and for shading */
public float value;
- // add visual cues here
-
- /** DOCUMENT ME!! */
+ /** Colour for position */
public Color colour;
/**