src/jalview/datamodel/Annotation.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer\r
   3  * Copyright (C) 2007 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  * DOCUMENT ME!\r
  25  *\r
  26  * @author $author$\r
  27  * @version $Revision$\r
  28  */\r
  29 public class Annotation\r
  30 {\r
  31   /** DOCUMENT ME!! */\r
  32   public String displayCharacter = "";\r
  33 \r
  34   /** DOCUMENT ME!! */\r
  35   public String description = ""; // currently used as mouse over\r
  36 \r
  37   /** DOCUMENT ME!! */\r
  38   public char secondaryStructure = ' '; // recognises H and E\r
  39 \r
  40   /** DOCUMENT ME!! */\r
  41   public float value;\r
  42 \r
  43   // add visual cues here\r
  44 \r
  45   /** DOCUMENT ME!! */\r
  46   public Color colour = Color.black;\r
  47 \r
  48   /**\r
  49    * Creates a new Annotation object.\r
  50    *\r
  51    * @param displayChar DOCUMENT ME!\r
  52    * @param desc DOCUMENT ME!\r
  53    * @param ss DOCUMENT ME!\r
  54    * @param val DOCUMENT ME!\r
  55    */\r
  56   public Annotation(String displayChar, String desc, char ss, float val)\r
  57   {\r
  58     displayCharacter = displayChar;\r
  59     description = desc;\r
  60     secondaryStructure = ss;\r
  61     value = val;\r
  62   }\r
  63 \r
  64   /**\r
  65    * Creates a new Annotation object.\r
  66    *\r
  67    * @param displayChar DOCUMENT ME!\r
  68    * @param desc DOCUMENT ME!\r
  69    * @param ss DOCUMENT ME!\r
  70    * @param val DOCUMENT ME!\r
  71    * @param colour DOCUMENT ME!\r
  72    */\r
  73   public Annotation(String displayChar, String desc, char ss, float val,\r
  74                     Color colour)\r
  75   {\r
  76     this(displayChar, desc, ss, val);\r
  77     this.colour = colour;\r
  78   }\r
  79 }\r