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