src/jalview/datamodel/Annotation.java

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