Formatting
[jalview.git] / src / jalview / gui / SequenceRenderer.java
index 896fda5..70f67d7 100755 (executable)
@@ -1,6 +1,6 @@
 /*\r
  * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+ * Copyright (C) 2007 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
@@ -23,6 +23,12 @@ import java.awt.*;
 import jalview.datamodel.*;\r
 import jalview.schemes.*;\r
 \r
+/**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @author $author$\r
+ * @version $Revision$\r
+ */\r
 public class SequenceRenderer\r
 {\r
   AlignViewport av;\r
@@ -32,29 +38,74 @@ public class SequenceRenderer
   SequenceGroup[] allGroups = null;\r
   Color resBoxColour;\r
   Graphics graphics;\r
-\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
-  public void renderGaps(boolean b)\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param b DOCUMENT ME!\r
+   */\r
+  public void prepare(Graphics g, boolean renderGaps)\r
   {\r
-    renderGaps = b;\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
+         && (float) av.charWidth == dwidth);\r
+\r
+    this.renderGaps = renderGaps;\r
   }\r
 \r
-  public Color getResidueBoxColour(ColourSchemeI cs, SequenceI seq, int i)\r
+  public Color getResidueBoxColour(SequenceI seq, int i)\r
   {\r
-    getBoxColour(cs, seq, i);\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
+   * 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
+      resBoxColour = cs.findColour(seq.getCharAt(i), i);\r
+    }\r
+    else if (forOverview && !jalview.util.Comparison.isGap(seq.getCharAt(i)))\r
+    {\r
+      resBoxColour = Color.lightGray;\r
     }\r
     else\r
     {\r
@@ -62,149 +113,243 @@ public class SequenceRenderer
     }\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
+   * 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
-    graphics = g;\r
-\r
-    drawBoxes(seq, start, end, x1, y1, (int) width, height);\r
+    drawBoxes(seq, start, end, y1);\r
 \r
-    fm = g.getFontMetrics();\r
-    drawText(seq, start, end, x1, y1, (int) width, height);\r
+    if (av.validCharWidth)\r
+    {\r
+      drawText(seq, start, end, y1);\r
+    }\r
   }\r
 \r
-  public void drawBoxes(SequenceI seq, int start, int end, int x1, int y1,\r
-                        int width, int height)\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 = width;\r
+    int curWidth = av.charWidth;\r
 \r
     Color tempColour = null;\r
 \r
-    while ( (i <= end) && (i < length))\r
+    while (i <= end)\r
     {\r
-      if (inCurrentSequenceGroup(i))\r
+      resBoxColour = Color.white;\r
+\r
+      if (i < length)\r
       {\r
-        if (currentSequenceGroup.getDisplayBoxes())\r
+        if (inCurrentSequenceGroup(i))\r
         {\r
-          getBoxColour(currentSequenceGroup.cs, seq, i);\r
+          if (currentSequenceGroup.getDisplayBoxes())\r
+          {\r
+            getBoxColour(currentSequenceGroup.cs, seq, i);\r
+          }\r
         }\r
-        else\r
+        else if (av.getShowBoxes())\r
         {\r
-          resBoxColour = Color.white;\r
+          getBoxColour(av.globalColourScheme, seq, i);\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
 \r
       if (resBoxColour != tempColour)\r
       {\r
         if (tempColour != null)\r
         {\r
-          graphics.fillRect(x1 + (width * (curStart - start)), y1,\r
-                            curWidth, height);\r
+          graphics.fillRect(av.charWidth * (curStart - start), y1,\r
+                            curWidth, av.charHeight);\r
         }\r
 \r
         graphics.setColor(resBoxColour);\r
 \r
         curStart = i;\r
-        curWidth = width;\r
+        curWidth = av.charWidth;\r
         tempColour = resBoxColour;\r
       }\r
       else\r
       {\r
-        curWidth += width;\r
+        curWidth += av.charWidth;\r
       }\r
 \r
       i++;\r
     }\r
 \r
-    graphics.fillRect(x1 + (width * (curStart - start)), y1, curWidth,\r
-                      height);\r
+    graphics.fillRect(av.charWidth * (curStart - start), y1, curWidth,\r
+                      av.charHeight);\r
+\r
   }\r
 \r
-  public void drawText(SequenceI seq, int start, int end, int x1, int y1,\r
-                       int width, int height)\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
-    int pady = height / 5;\r
+    y1 += av.charHeight - av.charHeight / 5; // height/5 replaces pady\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
+    if (end + 1 >= seq.getLength())\r
     {\r
-      graphics.setColor(Color.black);\r
+      end = seq.getLength() - 1;\r
+    }\r
+    graphics.setColor(av.textColour);\r
 \r
-      if (i < sequence.length())\r
+    if (monospacedFont\r
+        && av.showText\r
+        && allGroups.length == 0\r
+        && !av.getColourText()\r
+        && av.thresholdTextColour == 0)\r
+    {\r
+      if (av.renderGaps)\r
       {\r
-        s = sequence.charAt(i);\r
+        graphics.drawString(seq.getSequenceAsString(start, end + 1), 0, y1);\r
       }\r
       else\r
       {\r
-        s = ' ';\r
+        char gap = av.getGapCharacter();\r
+        graphics.drawString(seq.getSequenceAsString(start, end + 1).replace(gap,\r
+            ' '), 0, y1);\r
       }\r
-\r
-      if (!renderGaps && jalview.util.Comparison.isGap(s))\r
-      {\r
-        continue;\r
-      }\r
-\r
-      if (inCurrentSequenceGroup(i))\r
+    }\r
+    else\r
+    {\r
+      boolean getboxColour = false;\r
+      for (int i = start; i <= end; i++)\r
       {\r
-        if (!currentSequenceGroup.getDisplayText())\r
+        graphics.setColor(av.textColour);\r
+        getboxColour = false;\r
+        s = seq.getCharAt(i);\r
+        if (!renderGaps && jalview.util.Comparison.isGap(s))\r
         {\r
           continue;\r
         }\r
 \r
-        if (currentSequenceGroup.getColourText())\r
+        if (inCurrentSequenceGroup(i))\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
+          if (!currentSequenceGroup.getDisplayText())\r
+          {\r
+            continue;\r
+          }\r
+\r
+          if (currentSequenceGroup.thresholdTextColour > 0\r
+              || currentSequenceGroup.getColourText())\r
+          {\r
+            getboxColour = true;\r
+            getBoxColour(currentSequenceGroup.cs, seq, i);\r
+\r
+            if (currentSequenceGroup.getColourText())\r
+            {\r
+              graphics.setColor(resBoxColour.darker());\r
+            }\r
+\r
+            if (currentSequenceGroup.thresholdTextColour > 0)\r
+            {\r
+              if (resBoxColour.getRed() +\r
+                  resBoxColour.getBlue() +\r
+                  resBoxColour.getGreen() <\r
+                  currentSequenceGroup.thresholdTextColour)\r
+              {\r
+                graphics.setColor(currentSequenceGroup.textColour2);\r
+              }\r
+            }\r
+          }\r
+          else\r
+          {\r
+            graphics.setColor(currentSequenceGroup.textColour);\r
+          }\r
 \r
-        if (av.getColourText())\r
+        }\r
+        else\r
         {\r
-          getBoxColour(av.getGlobalColourScheme(), seq, i);\r
+          if (!av.getShowText())\r
+          {\r
+            continue;\r
+          }\r
 \r
-          if (av.getShowBoxes())\r
+          if (av.getColourText())\r
           {\r
-            graphics.setColor(resBoxColour.darker());\r
+            getboxColour = true;\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
-          else\r
+\r
+          if (av.thresholdTextColour > 0)\r
           {\r
-            graphics.setColor(resBoxColour);\r
+            if (!getboxColour)\r
+            {\r
+              getBoxColour(av.globalColourScheme, seq, i);\r
+            }\r
+\r
+            if (resBoxColour.getRed() +\r
+                resBoxColour.getBlue() +\r
+                resBoxColour.getGreen() < av.thresholdTextColour)\r
+            {\r
+              graphics.setColor(av.textColour2);\r
+            }\r
           }\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 = (av.charWidth - fm.charWidth(s)) / 2;\r
+        graphics.drawString(String.valueOf(s),\r
+                            charOffset + av.charWidth * (i - start),\r
+                            y1);\r
+\r
+      }\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
@@ -226,29 +371,64 @@ public class SequenceRenderer
     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,\r
-                                  int y1, int width, int height)\r
+                                  int y1)\r
   {\r
-    int pady = height / 5;\r
+    int pady = av.charHeight / 5;\r
     int charOffset = 0;\r
     graphics.setColor(Color.BLACK);\r
-    graphics.fillRect(x1, y1, width * (end - start + 1), height);\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
-    for (int i = start; i <= end; i++)\r
+    if (av.validCharWidth)\r
     {\r
-      if (i < seq.getLength())\r
+      for (int i = start; i <= end; i++)\r
       {\r
-        s = seq.getSequence().charAt(i);\r
+        if (i < seq.getLength())\r
+        {\r
+          s = seq.getCharAt(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
-      charOffset = (width - fm.charWidth(s)) / 2;\r
+      char s = seq.getCharAt(res);\r
+\r
+      charOffset = (av.charWidth - fm.charWidth(s)) / 2;\r
       graphics.drawString(String.valueOf(s),\r
-                          charOffset + x1 + (width * (i - start)),\r
-                          (y1 + height) - pady);\r
+                          charOffset + x1,\r
+                          (y1 + av.charHeight) - pady);\r
     }\r
+\r
   }\r
 }\r