Checks end of sequence before drawing text
[jalview.git] / src / jalview / gui / SequenceRenderer.java
index b5b4677..81daef7 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
-import java.util.*;\r
 \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
-\r
-  public SequenceRenderer(AlignViewport av)\r
-  {\r
-    this.av = av;\r
-  }\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
+\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
-  public void renderGaps(boolean b)\r
-  {\r
-    renderGaps = b;\r
-  }\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param b DOCUMENT ME!\r
+     */\r
+    public void renderGaps(boolean b)\r
+    {\r
+        renderGaps = b;\r
+    }\r
 \r
-  public Color getResidueBoxColour(ColourSchemeI cs, SequenceI seq, int i)\r
-  {\r
-    getBoxColour(cs, seq, i);\r
-    return resBoxColour;\r
-  }\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param cs DOCUMENT ME!\r
+     * @param seq DOCUMENT ME!\r
+     * @param i DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public Color getResidueBoxColour(ColourSchemeI cs, SequenceI seq, int i)\r
+    {\r
+        getBoxColour(cs, seq, i);\r
 \r
-  void getBoxColour(ColourSchemeI cs, SequenceI seq, int i)\r
-  {\r
-   if (cs != null)\r
-       resBoxColour = cs.findColour(seq.getSequence(i, i + 1), i);\r
-   else\r
-       resBoxColour = Color.white;\r
-  }\r
+        return resBoxColour;\r
+    }\r
 \r
-  public void drawSequence(Graphics g,SequenceI seq,SequenceGroup [] sg, int start, int end, int x1, int y1, int width, int height)\r
-  {\r
-    allGroups = sg;\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\r
+        {\r
+            resBoxColour = Color.white;\r
+        }\r
+    }\r
 \r
-    graphics = g;\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(Graphics g, SequenceI seq, SequenceGroup[] sg,\r
+        int start, int end, int x1, int y1, int width, int height)\r
+    {\r
+        allGroups = sg;\r
 \r
-    drawBoxes(seq, start, end, x1, y1, (int) width, height);\r
+        graphics = g;\r
 \r
-    fm = g.getFontMetrics();\r
-    drawText(seq,start,end,x1,y1,(int)width,height);\r
+        drawBoxes(seq, start, end, x1, y1, (int) width, height);\r
 \r
-  }\r
+        fm = g.getFontMetrics();\r
+        drawText(seq, start, end, x1, y1, (int) width, height);\r
+    }\r
 \r
-  public void drawBoxes(SequenceI seq,int start, int end, int x1, int y1, int width, int height) {\r
-    int i      = start;\r
-    int length = seq.getLength();\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 drawBoxes(SequenceI seq, int start, int end, int x1, int y1,\r
+        int width, int height)\r
+    {\r
+        int i = start;\r
+        int length = seq.getLength();\r
 \r
-    int curStart = -1;\r
-    int curWidth = width;\r
+        int curStart = -1;\r
+        int curWidth = width;\r
 \r
-    Color tempColour = null;\r
-    while (i <= end && i < length)\r
-    {\r
-      if(inCurrentSequenceGroup(i))\r
-      {\r
-        if( currentSequenceGroup.getDisplayBoxes())\r
-             getBoxColour(currentSequenceGroup.cs, seq, i);\r
-        else\r
-             resBoxColour = Color.white;\r
-      }\r
-      else if(av.getShowBoxes())\r
-            getBoxColour(av.getGlobalColourScheme(), seq, i);\r
-      else\r
-        resBoxColour = Color.white;\r
+        Color tempColour = null;\r
 \r
+        while (i <= end)\r
+        {\r
+          resBoxColour = Color.white;\r
 \r
-      if (resBoxColour != tempColour)\r
-      {\r
-        if(tempColour!=null)\r
-          graphics.fillRect(x1+width*(curStart-start),y1,curWidth,height);\r
-        graphics.setColor(resBoxColour);\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.getGlobalColourScheme(), seq, i);\r
+            }\r
 \r
-        curStart = i;\r
-        curWidth = width;\r
-        tempColour = resBoxColour;\r
+          }\r
 \r
-      }\r
-      else\r
-        curWidth += width;\r
+            if (resBoxColour != tempColour)\r
+            {\r
+                if (tempColour != null)\r
+                {\r
+                    graphics.fillRect(x1 + (width * (curStart - start)), y1,\r
+                        curWidth, height);\r
+                }\r
 \r
-      i++;\r
-    }\r
+                graphics.setColor(resBoxColour);\r
 \r
+                curStart = i;\r
+                curWidth = width;\r
+                tempColour = resBoxColour;\r
+            }\r
+            else\r
+            {\r
+                curWidth += width;\r
+            }\r
 \r
-     graphics.fillRect(x1+width*(curStart-start),y1,curWidth,height);\r
-  }\r
+            i++;\r
+        }\r
 \r
-  public void drawText(SequenceI seq,int start, int end, int x1, int y1, int width, int height)\r
-  {\r
-    int pady = height/5;\r
-    int charOffset=0;\r
-    char s;\r
-    // Need to find the sequence position here.\r
+        graphics.fillRect(x1 + (width * (curStart - start)), y1, curWidth,\r
+            height);\r
+    }\r
 \r
-    String sequence  = seq.getSequence();\r
-    for (int i = start; i <= end; i++)\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 x1, int y1,\r
+        int width, int height)\r
     {\r
-        if(i<sequence.length())\r
-          s = sequence.charAt(i);\r
-        else\r
-          s = ' ';\r
+        int pady = height / 5;\r
+        int charOffset = 0;\r
+        char s;\r
 \r
-        if(!renderGaps && jalview.util.Comparison.isGap(s))\r
-          continue;\r
+        // Need to find the sequence position here.\r
+        String sequence = seq.getSequence();\r
 \r
+        if(end+1>=seq.getLength())\r
+          end = seq.getLength()-1;\r
 \r
-        if (inCurrentSequenceGroup(i))\r
+        for (int i = start; i <= end; i++)\r
         {\r
-          if(!currentSequenceGroup.getDisplayText())\r
-            continue;\r
+            graphics.setColor(Color.black);\r
+\r
+            s = sequence.charAt(i);\r
 \r
-            if (currentSequenceGroup.getColourText())\r
+            if (!renderGaps && jalview.util.Comparison.isGap(s))\r
             {\r
-              getBoxColour(currentSequenceGroup.cs, seq, i);\r
-              graphics.setColor(resBoxColour.darker());\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
-        }\r
-        else\r
-        {\r
-          if(!av.getShowText())\r
-            continue;\r
-\r
-          if(av.getColourText())\r
-           {\r
-             getBoxColour(av.getGlobalColourScheme(), seq, i);\r
-             if(av.getShowBoxes())\r
-              graphics.setColor(resBoxColour.darker());\r
             else\r
-              graphics.setColor(resBoxColour);\r
-           }\r
-           else\r
-             graphics.setColor(Color.black);\r
-        }\r
+            {\r
+                if (!av.getShowText())\r
+                {\r
+                    continue;\r
+                }\r
+\r
+                if (av.getColourText())\r
+                {\r
+                    getBoxColour(av.getGlobalColourScheme(), 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 =  (width - fm.charWidth(s))/2;\r
-          graphics.drawString(String.valueOf(s),\r
-                              charOffset + x1 + width * (i - start),\r
-                              y1 + height - pady);\r
+            charOffset = (width - fm.charWidth(s)) / 2;\r
+            graphics.drawString(String.valueOf(s),\r
+                charOffset + x1 + (width * (i - start)), (y1 + height) - pady);\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
-  }\r
-\r
-  boolean inCurrentSequenceGroup(int res)\r
-  {\r
-    if(allGroups ==null)\r
-      return false;\r
-\r
-    for(int i=0; i<allGroups.length; i++)\r
-      if(allGroups[i].getStartRes()<=res && allGroups[i].getEndRes()>=res)\r
-      {\r
-         currentSequenceGroup = allGroups[i];\r
-         return true;\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 false;\r
-  }\r
+                return true;\r
+            }\r
+        }\r
 \r
-  public void drawHighlightedText(SequenceI seq,int start, int end, int x1, int y1, int width, int height)\r
-  {\r
-    int pady = height/5;\r
-    int charOffset=0;\r
-    graphics.setColor(Color.BLACK);\r
-    graphics.fillRect(x1,y1,width*(end-start+1),height);\r
-    graphics.setColor(Color.white);\r
+        return false;\r
+    }\r
 \r
-    char s='~';\r
-    // Need to find the sequence position here.\r
-    for (int i = start; i <= end; i++)\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,\r
+        int y1, int width, int height)\r
     {\r
-       if(i<seq.getLength())\r
-          s = seq.getSequence().charAt(i);\r
+        int pady = height / 5;\r
+        int charOffset = 0;\r
+        graphics.setColor(Color.BLACK);\r
+        graphics.fillRect(x1, y1, width * (end - start + 1), height);\r
+        graphics.setColor(Color.white);\r
 \r
-     charOffset =  (width - fm.charWidth(s))/2;\r
-      graphics.drawString(String.valueOf(s), charOffset + x1 + width * (i - start), y1 + height - pady);\r
-    }\r
-  }\r
+        char s = '~';\r
 \r
+        // Need to find the sequence position here.\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 = (width - fm.charWidth(s)) / 2;\r
+            graphics.drawString(String.valueOf(s),\r
+                charOffset + x1 + (width * (i - start)), (y1 + height) - pady);\r
+        }\r
+    }\r
 }\r