/*
* Jalview - A Sequence Alignment Editor and Viewer
-* Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+* Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
-
package jalview.datamodel;
+
import java.awt.*;
+
+/**
+ * DOCUMENT ME!
+ *
+ * @author $author$
+ * @version $Revision$
+ */
public class Annotation
{
- public String displayCharacter="";
- public String description=""; // currently used as mouse over
- public char secondaryStructure=' '; // recognises H and E
- public float value;
-
- // add visual cues here
- public Color colour = Color.black;
-
- public Annotation(String displayChar, String desc, char ss, float val)
- {
- displayCharacter = displayChar;
- description = desc;
- secondaryStructure = ss;
- value = val;
- }
- public Annotation(String displayChar, String desc, char ss, float val, Color colour) {
- this(displayChar, desc, ss, val);
- this.colour = colour;
- }
+ /** DOCUMENT ME!! */
+ public String displayCharacter = "";
+
+ /** DOCUMENT ME!! */
+ public String description = ""; // currently used as mouse over
+
+ /** DOCUMENT ME!! */
+ public char secondaryStructure = ' '; // recognises H and E
+
+ /** DOCUMENT ME!! */
+ public float value;
+
+ // add visual cues here
+
+ /** DOCUMENT ME!! */
+ public Color colour = Color.black;
+
+ /**
+ * Creates a new Annotation object.
+ *
+ * @param displayChar DOCUMENT ME!
+ * @param desc DOCUMENT ME!
+ * @param ss DOCUMENT ME!
+ * @param val DOCUMENT ME!
+ */
+ public Annotation(String displayChar, String desc, char ss, float val)
+ {
+ displayCharacter = displayChar;
+ description = desc;
+ secondaryStructure = ss;
+ value = val;
+ }
+
+ /**
+ * Creates a new Annotation object.
+ *
+ * @param displayChar DOCUMENT ME!
+ * @param desc DOCUMENT ME!
+ * @param ss DOCUMENT ME!
+ * @param val DOCUMENT ME!
+ * @param colour DOCUMENT ME!
+ */
+ public Annotation(String displayChar, String desc, char ss, float val,
+ Color colour)
+ {
+ this(displayChar, desc, ss, val);
+ this.colour = colour;
+ }
}