JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob
[jalview.git] / src / jalview / gui / SequenceRenderer.java
index f41a0b9..8c4ead8 100755 (executable)
-/*\r
- * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
- *\r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
- */\r
-package jalview.gui;\r
-\r
-import jalview.datamodel.*;\r
-\r
-import jalview.schemes.*;\r
-\r
-import java.awt.*;\r
-\r
-/**\r
- * DOCUMENT ME!\r
- *\r
- * @author $author$\r
- * @version $Revision$\r
- */\r
-public class SequenceRenderer\r
-{\r
-    AlignViewport av;\r
-    FontMetrics fm;\r
-    boolean renderGaps = true;\r
-    SequenceGroup currentSequenceGroup = null;\r
-    SequenceGroup[] allGroups = null;\r
-    Color resBoxColour;\r
-    Graphics graphics;\r
-    boolean monospacedFont;\r
-    boolean forOverview = false;\r
-\r
-    /**\r
-     * Creates a new SequenceRenderer object.\r
-     *\r
-     * @param av DOCUMENT ME!\r
-     */\r
-    public SequenceRenderer(AlignViewport av)\r
-    {\r
-        this.av = av;\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param b DOCUMENT ME!\r
-     */\r
-    public void prepare(Graphics g, boolean renderGaps)\r
-    {\r
-        graphics = g;\r
-        fm = g.getFontMetrics();\r
-\r
-        // If EPS graphics, stringWidth will be a double, not an int\r
-        double dwidth = fm.getStringBounds("M", g).getWidth();\r
-\r
-        monospacedFont =\r
-               dwidth == fm.getStringBounds("|",g).getWidth()\r
-               && dwidth == (int)dwidth;\r
-\r
-        this.renderGaps = renderGaps;\r
-    }\r
-\r
-\r
-    public Color getResidueBoxColour(SequenceI seq, int i)\r
-    {\r
-      allGroups = av.alignment.findAllGroups(seq);\r
-\r
-      if (inCurrentSequenceGroup(i))\r
-      {\r
-        if (currentSequenceGroup.getDisplayBoxes())\r
-        {\r
-          getBoxColour(currentSequenceGroup.cs, seq, i);\r
-        }\r
-      }\r
-      else if (av.getShowBoxes())\r
-      {\r
-          getBoxColour(av.globalColourScheme, seq, i);\r
-      }\r
-\r
-      return resBoxColour;\r
-    }\r
-\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param cs DOCUMENT ME!\r
-     * @param seq DOCUMENT ME!\r
-     * @param i DOCUMENT ME!\r
-     */\r
-    void getBoxColour(ColourSchemeI cs, SequenceI seq, int i)\r
-    {\r
-        if (cs != null)\r
-        {\r
-            resBoxColour = cs.findColour(seq.getSequence(i, i + 1), i);\r
-        }\r
-        else if(forOverview && !jalview.util.Comparison.isGap(seq.getCharAt(i)))\r
-        {\r
-            resBoxColour = Color.lightGray;\r
-        }\r
-        else\r
-        {\r
-          resBoxColour = Color.white;\r
-        }\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param g DOCUMENT ME!\r
-     * @param seq DOCUMENT ME!\r
-     * @param sg DOCUMENT ME!\r
-     * @param start DOCUMENT ME!\r
-     * @param end DOCUMENT ME!\r
-     * @param x1 DOCUMENT ME!\r
-     * @param y1 DOCUMENT ME!\r
-     * @param width DOCUMENT ME!\r
-     * @param height DOCUMENT ME!\r
-     */\r
-    public void drawSequence(SequenceI seq, SequenceGroup[] sg,\r
-        int start, int end, int y1)\r
-    {\r
-        allGroups = sg;\r
-\r
-        drawBoxes(seq, start, end, y1);\r
-\r
-        if (av.validCharWidth)\r
-          drawText(seq, start, end, y1);\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param seq DOCUMENT ME!\r
-     * @param start DOCUMENT ME!\r
-     * @param end DOCUMENT ME!\r
-     * @param x1 DOCUMENT ME!\r
-     * @param y1 DOCUMENT ME!\r
-     * @param width DOCUMENT ME!\r
-     * @param height DOCUMENT ME!\r
-     */\r
-    public synchronized void drawBoxes(SequenceI seq, int start, int end, int y1)\r
-    {\r
-      int i = start;\r
-      int length = seq.getLength();\r
-\r
-      int curStart = -1;\r
-      int curWidth = av.charWidth;\r
-\r
-      Color tempColour = null;\r
-\r
-      while (i <= end)\r
-      {\r
-        resBoxColour = Color.white;\r
-\r
-        if (i < length)\r
-        {\r
-          if (inCurrentSequenceGroup(i))\r
-          {\r
-            if (currentSequenceGroup.getDisplayBoxes())\r
-            {\r
-              getBoxColour(currentSequenceGroup.cs, seq, i);\r
-            }\r
-          }\r
-          else if (av.getShowBoxes())\r
-          {\r
-            getBoxColour(av.globalColourScheme, seq, i);\r
-          }\r
-\r
-        }\r
-\r
-          if (resBoxColour != tempColour)\r
-          {\r
-              if (tempColour != null)\r
-              {\r
-                  graphics.fillRect( av.charWidth * (curStart - start), y1,\r
-                      curWidth, av.charHeight);\r
-              }\r
-\r
-              graphics.setColor(resBoxColour);\r
-\r
-              curStart = i;\r
-              curWidth = av.charWidth;\r
-              tempColour = resBoxColour;\r
-          }\r
-          else\r
-          {\r
-              curWidth += av.charWidth;\r
-          }\r
-\r
-          i++;\r
-      }\r
-\r
-      graphics.fillRect( av.charWidth * (curStart - start), y1, curWidth,\r
-          av.charHeight);\r
-\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param seq DOCUMENT ME!\r
-     * @param start DOCUMENT ME!\r
-     * @param end DOCUMENT ME!\r
-     * @param x1 DOCUMENT ME!\r
-     * @param y1 DOCUMENT ME!\r
-     * @param width DOCUMENT ME!\r
-     * @param height DOCUMENT ME!\r
-     */\r
-    public void drawText(SequenceI seq, int start, int end, int y1)\r
-    {\r
-      y1 += av.charHeight - av.charHeight / 5; // height/5 replaces pady\r
-      int charOffset = 0;\r
-      char s;\r
-\r
-        if(end+1>=seq.getLength())\r
-          end = seq.getLength()-1;\r
-        graphics.setColor(Color.black);\r
-\r
-\r
-        if(monospacedFont && av.showText && allGroups.length==0 && !av.getColourText())\r
-        {\r
-          if(av.renderGaps)\r
-          graphics.drawString(seq.getSequence(start, end + 1), 0, y1);\r
-         else\r
-         {\r
-           char gap = av.getGapCharacter();\r
-           graphics.drawString( seq.getSequence(start, end+1).replace(gap, ' '), 0, y1);\r
-         }\r
-        }\r
-        else\r
-        {\r
-          for (int i = start; i <= end; i++)\r
-          {\r
-            graphics.setColor(Color.black);\r
-            s = seq.getCharAt(i);\r
-            if (!renderGaps && jalview.util.Comparison.isGap(s))\r
-            {\r
-              continue;\r
-            }\r
-\r
-            if (inCurrentSequenceGroup(i))\r
-            {\r
-              if (!currentSequenceGroup.getDisplayText())\r
-              {\r
-                continue;\r
-              }\r
-\r
-              if (currentSequenceGroup.getColourText())\r
-              {\r
-                getBoxColour(currentSequenceGroup.cs, seq, i);\r
-                graphics.setColor(resBoxColour.darker());\r
-              }\r
-            }\r
-            else\r
-            {\r
-              if (!av.getShowText())\r
-              {\r
-                continue;\r
-              }\r
-\r
-              if (av.getColourText())\r
-              {\r
-                getBoxColour(av.globalColourScheme, seq, i);\r
-\r
-                if (av.getShowBoxes())\r
-                {\r
-                  graphics.setColor(resBoxColour.darker());\r
-                }\r
-                else\r
-                {\r
-                  graphics.setColor(resBoxColour);\r
-                }\r
-              }\r
-            }\r
-\r
-            charOffset = (av.charWidth - fm.charWidth(s)) / 2;\r
-\r
-          //  System.out.print(s);\r
-            graphics.drawString(String.valueOf(s),\r
-                                charOffset + av.charWidth * (i - start),\r
-                                y1);\r
-\r
-          }\r
-        //  System.out.println("\n");\r
-        }\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param res DOCUMENT ME!\r
-     *\r
-     * @return DOCUMENT ME!\r
-     */\r
-    boolean inCurrentSequenceGroup(int res)\r
-    {\r
-        if (allGroups == null)\r
-        {\r
-            return false;\r
-        }\r
-\r
-        for (int i = 0; i < allGroups.length; i++)\r
-        {\r
-            if ((allGroups[i].getStartRes() <= res) &&\r
-                    (allGroups[i].getEndRes() >= res))\r
-            {\r
-                currentSequenceGroup = allGroups[i];\r
-\r
-                return true;\r
-            }\r
-        }\r
-\r
-        return false;\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param seq DOCUMENT ME!\r
-     * @param start DOCUMENT ME!\r
-     * @param end DOCUMENT ME!\r
-     * @param x1 DOCUMENT ME!\r
-     * @param y1 DOCUMENT ME!\r
-     * @param width DOCUMENT ME!\r
-     * @param height DOCUMENT ME!\r
-     */\r
-    public void drawHighlightedText(SequenceI seq, int start, int end, int x1, int y1)\r
-    {\r
-        int pady = av.charHeight / 5;\r
-        int charOffset = 0;\r
-        graphics.setColor(Color.BLACK);\r
-        graphics.fillRect(x1, y1, av.charWidth * (end - start + 1), av.charHeight);\r
-        graphics.setColor(Color.white);\r
-\r
-        char s = '~';\r
-\r
-        // Need to find the sequence position here.\r
-        if(av.validCharWidth)\r
-        {\r
-          for (int i = start; i <= end; i++)\r
-          {\r
-            if (i < seq.getLength())\r
-            {\r
-              s = seq.getSequence().charAt(i);\r
-            }\r
-\r
-            charOffset = (av.charWidth - fm.charWidth(s)) / 2;\r
-            graphics.drawString(String.valueOf(s),\r
-                                charOffset + x1 + (av.charWidth * (i - start)),\r
-                                (y1 + av.charHeight) - pady);\r
-          }\r
-        }\r
-    }\r
-\r
-    public void drawCursor(SequenceI seq, int res, int x1, int y1)\r
-    {\r
-      int pady = av.charHeight / 5;\r
-      int charOffset = 0;\r
-      graphics.setColor(Color.black);\r
-      graphics.fillRect(x1, y1, av.charWidth, av.charHeight);\r
-\r
-      if(av.validCharWidth)\r
-      {\r
-        graphics.setColor(Color.white);\r
-\r
-        char s = seq.getCharAt(res);\r
-\r
-        charOffset = (av.charWidth - fm.charWidth(s)) / 2;\r
-        graphics.drawString(String.valueOf(s),\r
-                            charOffset + x1,\r
-                            (y1 + av.charHeight) - pady);\r
-      }\r
-\r
-    }\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
+ * Copyright (C) 2015 The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.gui;
+
+import jalview.api.FeatureRenderer;
+import jalview.datamodel.SequenceGroup;
+import jalview.datamodel.SequenceI;
+import jalview.schemes.ColourSchemeI;
+
+import java.awt.Color;
+import java.awt.FontMetrics;
+import java.awt.Graphics;
+
+/**
+ * DOCUMENT ME!
+ * 
+ * @author $author$
+ * @version $Revision$
+ */
+public class SequenceRenderer implements jalview.api.SequenceRenderer
+{
+  final static int CHAR_TO_UPPER = 'A' - 'a';
+
+  AlignViewport av;
+
+  FontMetrics fm;
+
+  boolean renderGaps = true;
+
+  SequenceGroup currentSequenceGroup = null;
+
+  SequenceGroup[] allGroups = null;
+
+  Color resBoxColour;
+
+  Graphics graphics;
+
+  boolean monospacedFont;
+
+  boolean forOverview = false;
+
+  /**
+   * Creates a new SequenceRenderer object.
+   * 
+   * @param av
+   *          DOCUMENT ME!
+   */
+  public SequenceRenderer(AlignViewport av)
+  {
+    this.av = av;
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param b
+   *          DOCUMENT ME!
+   */
+  public void prepare(Graphics g, boolean renderGaps)
+  {
+    graphics = g;
+    fm = g.getFontMetrics();
+
+    // If EPS graphics, stringWidth will be a double, not an int
+    double dwidth = fm.getStringBounds("M", g).getWidth();
+
+    monospacedFont = (dwidth == fm.getStringBounds("|", g).getWidth() && av
+            .getCharWidth() == dwidth);
+
+    this.renderGaps = renderGaps;
+  }
+
+  @Override
+  public Color getResidueBoxColour(SequenceI seq, int i)
+  {
+    allGroups = av.getAlignment().findAllGroups(seq);
+
+    if (inCurrentSequenceGroup(i))
+    {
+      if (currentSequenceGroup.getDisplayBoxes())
+      {
+        getBoxColour(currentSequenceGroup.cs, seq, i);
+      }
+    }
+    else if (av.getShowBoxes())
+    {
+      getBoxColour(av.getGlobalColourScheme(), seq, i);
+    }
+
+    return resBoxColour;
+  }
+
+  /**
+   * Get the residue colour at the given sequence position - as determined by
+   * the sequence group colour (if any), else the colour scheme, possibly
+   * overridden by a feature colour.
+   * 
+   * @param seq
+   * @param position
+   * @param fr
+   * @return
+   */
+  @Override
+  public Color getResidueColour(final SequenceI seq, int position,
+          FeatureRenderer fr)
+  {
+    // TODO replace 8 or so code duplications with calls to this method
+    // (refactored as needed)
+    Color col = getResidueBoxColour(seq, position);
+
+    if (fr != null)
+    {
+      col = fr.findFeatureColour(col, seq, position);
+    }
+    return col;
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param cs
+   *          DOCUMENT ME!
+   * @param seq
+   *          DOCUMENT ME!
+   * @param i
+   *          DOCUMENT ME!
+   */
+  void getBoxColour(ColourSchemeI cs, SequenceI seq, int i)
+  {
+    if (cs != null)
+    {
+      resBoxColour = cs.findColour(seq.getCharAt(i), i, seq);
+    }
+    else if (forOverview
+            && !jalview.util.Comparison.isGap(seq.getCharAt(i)))
+    {
+      resBoxColour = Color.lightGray;
+    }
+    else
+    {
+      resBoxColour = Color.white;
+    }
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param g
+   *          DOCUMENT ME!
+   * @param seq
+   *          DOCUMENT ME!
+   * @param sg
+   *          DOCUMENT ME!
+   * @param start
+   *          DOCUMENT ME!
+   * @param end
+   *          DOCUMENT ME!
+   * @param x1
+   *          DOCUMENT ME!
+   * @param y1
+   *          DOCUMENT ME!
+   * @param width
+   *          DOCUMENT ME!
+   * @param height
+   *          DOCUMENT ME!
+   */
+  public void drawSequence(SequenceI seq, SequenceGroup[] sg, int start,
+          int end, int y1)
+  {
+    allGroups = sg;
+
+    drawBoxes(seq, start, end, y1);
+
+    if (av.validCharWidth)
+    {
+      drawText(seq, start, end, y1);
+    }
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param seq
+   *          DOCUMENT ME!
+   * @param start
+   *          DOCUMENT ME!
+   * @param end
+   *          DOCUMENT ME!
+   * @param x1
+   *          DOCUMENT ME!
+   * @param y1
+   *          DOCUMENT ME!
+   * @param width
+   *          DOCUMENT ME!
+   * @param height
+   *          DOCUMENT ME!
+   */
+  public synchronized void drawBoxes(SequenceI seq, int start, int end,
+          int y1)
+  {
+    if (seq == null)
+    {
+      return; // fix for racecondition
+    }
+    int i = start;
+    int length = seq.getLength();
+
+    int curStart = -1;
+    int curWidth = av.getCharWidth(), avWidth = av.getCharWidth(), avHeight = av
+            .getCharHeight();
+
+    Color tempColour = null;
+
+    while (i <= end)
+    {
+      resBoxColour = Color.white;
+
+      if (i < length)
+      {
+        if (inCurrentSequenceGroup(i))
+        {
+          if (currentSequenceGroup.getDisplayBoxes())
+          {
+            getBoxColour(currentSequenceGroup.cs, seq, i);
+          }
+        }
+        else if (av.getShowBoxes())
+        {
+          getBoxColour(av.getGlobalColourScheme(), seq, i);
+        }
+
+      }
+
+      if (resBoxColour != tempColour)
+      {
+        if (tempColour != null)
+        {
+          graphics.fillRect(avWidth * (curStart - start), y1, curWidth,
+                  avHeight);
+        }
+
+        graphics.setColor(resBoxColour);
+
+        curStart = i;
+        curWidth = avWidth;
+        tempColour = resBoxColour;
+      }
+      else
+      {
+        curWidth += avWidth;
+      }
+
+      i++;
+    }
+
+    graphics.fillRect(avWidth * (curStart - start), y1, curWidth, avHeight);
+
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param seq
+   *          DOCUMENT ME!
+   * @param start
+   *          DOCUMENT ME!
+   * @param end
+   *          DOCUMENT ME!
+   * @param x1
+   *          DOCUMENT ME!
+   * @param y1
+   *          DOCUMENT ME!
+   * @param width
+   *          DOCUMENT ME!
+   * @param height
+   *          DOCUMENT ME!
+   */
+  public void drawText(SequenceI seq, int start, int end, int y1)
+  {
+    y1 += av.getCharHeight() - av.getCharHeight() / 5; // height/5 replaces pady
+    int charOffset = 0;
+    char s;
+
+    if (end + 1 >= seq.getLength())
+    {
+      end = seq.getLength() - 1;
+    }
+    graphics.setColor(av.getTextColour());
+
+    if (monospacedFont && av.getShowText() && allGroups.length == 0
+            && !av.getColourText() && av.getThresholdTextColour() == 0)
+    {
+      if (av.isRenderGaps())
+      {
+        graphics.drawString(seq.getSequenceAsString(start, end + 1), 0, y1);
+      }
+      else
+      {
+        char gap = av.getGapCharacter();
+        graphics.drawString(seq.getSequenceAsString(start, end + 1)
+                .replace(gap, ' '), 0, y1);
+      }
+    }
+    else
+    {
+      boolean srep = av.isDisplayReferenceSeq();
+      boolean getboxColour = false;
+      boolean isarep = av.getAlignment().getSeqrep() == seq;
+      boolean isgrep = currentSequenceGroup != null ? currentSequenceGroup
+              .getSeqrep() == seq : false;
+      char sr_c;
+      for (int i = start; i <= end; i++)
+      {
+
+        graphics.setColor(av.getTextColour());
+        getboxColour = false;
+        s = seq.getCharAt(i);
+
+        if (!renderGaps && jalview.util.Comparison.isGap(s))
+        {
+          continue;
+        }
+
+        if (inCurrentSequenceGroup(i))
+        {
+          if (!currentSequenceGroup.getDisplayText())
+          {
+            continue;
+          }
+
+          if (currentSequenceGroup.thresholdTextColour > 0
+                  || currentSequenceGroup.getColourText())
+          {
+            getboxColour = true;
+            getBoxColour(currentSequenceGroup.cs, seq, i);
+
+            if (currentSequenceGroup.getColourText())
+            {
+              graphics.setColor(resBoxColour.darker());
+            }
+
+            if (currentSequenceGroup.thresholdTextColour > 0)
+            {
+              if (resBoxColour.getRed() + resBoxColour.getBlue()
+                      + resBoxColour.getGreen() < currentSequenceGroup.thresholdTextColour)
+              {
+                graphics.setColor(currentSequenceGroup.textColour2);
+              }
+            }
+          }
+          else
+          {
+            graphics.setColor(currentSequenceGroup.textColour);
+          }
+          if (!isarep && !isgrep
+                  && currentSequenceGroup.getShowNonconserved()) // todo
+                                                                 // optimize
+          {
+            // todo - use sequence group consensus
+            s = getDisplayChar(srep, i, s, '.', currentSequenceGroup);
+
+          }
+
+        }
+        else
+        {
+          if (!av.getShowText())
+          {
+            continue;
+          }
+
+          if (av.getColourText())
+          {
+            getboxColour = true;
+            getBoxColour(av.getGlobalColourScheme(), seq, i);
+
+            if (av.getShowBoxes())
+            {
+              graphics.setColor(resBoxColour.darker());
+            }
+            else
+            {
+              graphics.setColor(resBoxColour);
+            }
+          }
+
+          if (av.getThresholdTextColour() > 0)
+          {
+            if (!getboxColour)
+            {
+              getBoxColour(av.getGlobalColourScheme(), seq, i);
+            }
+
+            if (resBoxColour.getRed() + resBoxColour.getBlue()
+                    + resBoxColour.getGreen() < av.getThresholdTextColour())
+            {
+              graphics.setColor(av.getTextColour2());
+            }
+          }
+          if (!isarep && av.getShowUnconserved())
+          {
+            s = getDisplayChar(srep, i, s, '.', currentSequenceGroup);
+
+          }
+
+        }
+
+        charOffset = (av.getCharWidth() - fm.charWidth(s)) / 2;
+        graphics.drawString(String.valueOf(s),
+                charOffset + av.getCharWidth() * (i - start), y1);
+
+      }
+    }
+  }
+
+  /**
+   * Returns 'conservedChar' to represent the given position if the sequence
+   * character at that position is equal to the consensus (ignoring case), else
+   * returns the sequence character
+   * 
+   * @param usesrep
+   * @param position
+   * @param sequenceChar
+   * @param conservedChar
+   * @return
+   */
+  private char getDisplayChar(final boolean usesrep, int position,
+          char sequenceChar, char conservedChar, SequenceGroup currentGroup)
+  {
+    // TODO - use currentSequenceGroup rather than alignment
+    // currentSequenceGroup.getConsensus()
+    char conschar = (usesrep) ? (currentGroup == null ? av.getAlignment()
+            .getSeqrep().getCharAt(position)
+            : (currentGroup.getSeqrep() != null ? currentGroup.getSeqrep()
+                    .getCharAt(position) : av.getAlignment().getSeqrep()
+                    .getCharAt(position)))
+            : (currentGroup != null && currentGroup.getConsensus() != null) ? currentGroup
+                    .getConsensus().annotations[position].displayCharacter
+                    .charAt(0)
+                    : av.getAlignmentConsensusAnnotation().annotations[position].displayCharacter
+                            .charAt(0);
+    if (!jalview.util.Comparison.isGap(conschar)
+            && (sequenceChar == conschar || sequenceChar + CHAR_TO_UPPER == conschar))
+    {
+      sequenceChar = conservedChar;
+    }
+    return sequenceChar;
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param res
+   *          DOCUMENT ME!
+   * 
+   * @return DOCUMENT ME!
+   */
+  boolean inCurrentSequenceGroup(int res)
+  {
+    if (allGroups == null)
+    {
+      return false;
+    }
+
+    for (int i = 0; i < allGroups.length; i++)
+    {
+      if ((allGroups[i].getStartRes() <= res)
+              && (allGroups[i].getEndRes() >= res))
+      {
+        currentSequenceGroup = allGroups[i];
+
+        return true;
+      }
+    }
+
+    return false;
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param seq
+   *          DOCUMENT ME!
+   * @param start
+   *          DOCUMENT ME!
+   * @param end
+   *          DOCUMENT ME!
+   * @param x1
+   *          DOCUMENT ME!
+   * @param y1
+   *          DOCUMENT ME!
+   * @param width
+   *          DOCUMENT ME!
+   * @param height
+   *          DOCUMENT ME!
+   */
+  public void drawHighlightedText(SequenceI seq, int start, int end,
+          int x1, int y1)
+  {
+    int pady = av.getCharHeight() / 5;
+    int charOffset = 0;
+    graphics.setColor(Color.BLACK);
+    graphics.fillRect(x1, y1, av.getCharWidth() * (end - start + 1),
+            av.getCharHeight());
+    graphics.setColor(Color.white);
+
+    char s = '~';
+
+    // Need to find the sequence position here.
+    if (av.isValidCharWidth())
+    {
+      for (int i = start; i <= end; i++)
+      {
+        if (i < seq.getLength())
+        {
+          s = seq.getCharAt(i);
+        }
+
+        charOffset = (av.getCharWidth() - fm.charWidth(s)) / 2;
+        graphics.drawString(String.valueOf(s),
+                charOffset + x1 + (av.getCharWidth() * (i - start)),
+                (y1 + av.getCharHeight()) - pady);
+      }
+    }
+  }
+
+  public void drawCursor(SequenceI seq, int res, int x1, int y1)
+  {
+    int pady = av.getCharHeight() / 5;
+    int charOffset = 0;
+    graphics.setColor(Color.black);
+    graphics.fillRect(x1, y1, av.getCharWidth(), av.getCharHeight());
+
+    if (av.isValidCharWidth())
+    {
+      graphics.setColor(Color.white);
+
+      char s = seq.getCharAt(res);
+
+      charOffset = (av.getCharWidth() - fm.charWidth(s)) / 2;
+      graphics.drawString(String.valueOf(s), charOffset + x1,
+              (y1 + av.getCharHeight()) - pady);
+    }
+
+  }
+}