src/jalview/datamodel/Annotation.java

   1 /*
   2 * Jalview - A Sequence Alignment Editor and Viewer
   3 * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
   4 *
   5 * This program is free software; you can redistribute it and/or
   6 * modify it under the terms of the GNU General Public License
   7 * as published by the Free Software Foundation; either version 2
   8 * of the License, or (at your option) any later version.
   9 *
  10 * This program is distributed in the hope that it will be useful,
  11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 * GNU General Public License for more details.
  14 *
  15 * You should have received a copy of the GNU General Public License
  16 * along with this program; if not, write to the Free Software
  17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  18 */
  19 package jalview.datamodel;
  20
  21 import java.awt.*;
  22
  23
  24 /**
  25  * DOCUMENT ME!
  26  *
  27  * @author $author$
  28  * @version $Revision$
  29  */
  30 public class Annotation
  31 {
  32     /** DOCUMENT ME!! */
  33     public String displayCharacter = "";
  34
  35     /** DOCUMENT ME!! */
  36     public String description = ""; // currently used as mouse over
  37
  38     /** DOCUMENT ME!! */
  39     public char secondaryStructure = ' '; // recognises H and E
  40
  41     /** DOCUMENT ME!! */
  42     public float value;
  43
  44     // add visual cues here
  45
  46     /** DOCUMENT ME!! */
  47     public Color colour = Color.black;
  48
  49     /**
  50      * Creates a new Annotation object.
  51      *
  52      * @param displayChar DOCUMENT ME!
  53      * @param desc DOCUMENT ME!
  54      * @param ss DOCUMENT ME!
  55      * @param val DOCUMENT ME!
  56      */
  57     public Annotation(String displayChar, String desc, char ss, float val)
  58     {
  59         displayCharacter = displayChar;
  60         description = desc;
  61         secondaryStructure = ss;
  62         value = val;
  63     }
  64
  65     /**
  66      * Creates a new Annotation object.
  67      *
  68      * @param displayChar DOCUMENT ME!
  69      * @param desc DOCUMENT ME!
  70      * @param ss DOCUMENT ME!
  71      * @param val DOCUMENT ME!
  72      * @param colour DOCUMENT ME!
  73      */
  74     public Annotation(String displayChar, String desc, char ss, float val,
  75         Color colour)
  76     {
  77         this(displayChar, desc, ss, val);
  78         this.colour = colour;
  79     }
  80 }