src/jalview/gui/SequenceRenderer.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer\r
   3  * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4  *\r
   5  * This program is free software; you can redistribute it and/or\r
   6  * modify it under the terms of the GNU General Public License\r
   7  * as published by the Free Software Foundation; either version 2\r
   8  * of the License, or (at your option) any later version.\r
   9  *\r
  10  * This program is distributed in the hope that it will be useful,\r
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13  * GNU General Public License for more details.\r
  14  *\r
  15  * You should have received a copy of the GNU General Public License\r
  16  * along with this program; if not, write to the Free Software\r
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18  */\r
  19 package jalview.gui;\r
  20 \r
  21 import jalview.datamodel.*;\r
  22 \r
  23 import jalview.schemes.*;\r
  24 \r
  25 import java.awt.*;\r
  26 \r
  27 /**\r
  28  * DOCUMENT ME!\r
  29  *\r
  30  * @author $author$\r
  31  * @version $Revision$\r
  32  */\r
  33 public class SequenceRenderer\r
  34 {\r
  35     AlignViewport av;\r
  36     FontMetrics fm;\r
  37     boolean renderGaps = true;\r
  38     SequenceGroup currentSequenceGroup = null;\r
  39     SequenceGroup[] allGroups = null;\r
  40     Color resBoxColour;\r
  41     Graphics graphics;\r
  42     boolean monospacedFont;\r
  43 \r
  44     /**\r
  45      * Creates a new SequenceRenderer object.\r
  46      *\r
  47      * @param av DOCUMENT ME!\r
  48      */\r
  49     public SequenceRenderer(AlignViewport av)\r
  50     {\r
  51         this.av = av;\r
  52     }\r
  53 \r
  54     /**\r
  55      * DOCUMENT ME!\r
  56      *\r
  57      * @param b DOCUMENT ME!\r
  58      */\r
  59     public void renderGaps(boolean b)\r
  60     {\r
  61         renderGaps = b;\r
  62     }\r
  63 \r
  64 \r
  65     public Color getResidueBoxColour(SequenceI seq, int i)\r
  66     {\r
  67       allGroups = av.alignment.findAllGroups(seq);\r
  68 \r
  69       if (inCurrentSequenceGroup(i))\r
  70       {\r
  71         if (currentSequenceGroup.getDisplayBoxes())\r
  72         {\r
  73           getBoxColour(currentSequenceGroup.cs, seq, i);\r
  74         }\r
  75       }\r
  76       else if (av.getShowBoxes())\r
  77       {\r
  78           getBoxColour(av.globalColourScheme, seq, i);\r
  79       }\r
  80 \r
  81       return resBoxColour;\r
  82     }\r
  83 \r
  84 \r
  85     /**\r
  86      * DOCUMENT ME!\r
  87      *\r
  88      * @param cs DOCUMENT ME!\r
  89      * @param seq DOCUMENT ME!\r
  90      * @param i DOCUMENT ME!\r
  91      */\r
  92     void getBoxColour(ColourSchemeI cs, SequenceI seq, int i)\r
  93     {\r
  94         if (cs != null)\r
  95         {\r
  96             resBoxColour = cs.findColour(seq.getSequence(i, i + 1), i);\r
  97         }\r
  98         else\r
  99         {\r
 100             resBoxColour = Color.white;\r
 101         }\r
 102     }\r
 103 \r
 104     /**\r
 105      * DOCUMENT ME!\r
 106      *\r
 107      * @param g DOCUMENT ME!\r
 108      * @param seq DOCUMENT ME!\r
 109      * @param sg DOCUMENT ME!\r
 110      * @param start DOCUMENT ME!\r
 111      * @param end DOCUMENT ME!\r
 112      * @param x1 DOCUMENT ME!\r
 113      * @param y1 DOCUMENT ME!\r
 114      * @param width DOCUMENT ME!\r
 115      * @param height DOCUMENT ME!\r
 116      */\r
 117     public void drawSequence(Graphics g, SequenceI seq, SequenceGroup[] sg,\r
 118         int start, int end, int x1, int y1, int width, int height)\r
 119     {\r
 120         allGroups = sg;\r
 121 \r
 122         graphics = g;\r
 123 \r
 124         drawBoxes(seq, start, end, x1, y1, (int) width, height);\r
 125 \r
 126         fm = g.getFontMetrics();\r
 127 \r
 128         monospacedFont = fm.getStringBounds("M",g).getWidth()==fm.getStringBounds("|",g).getWidth();\r
 129 \r
 130         drawText(seq, start, end, x1, y1, (int) width, height);\r
 131     }\r
 132 \r
 133     /**\r
 134      * DOCUMENT ME!\r
 135      *\r
 136      * @param seq DOCUMENT ME!\r
 137      * @param start DOCUMENT ME!\r
 138      * @param end DOCUMENT ME!\r
 139      * @param x1 DOCUMENT ME!\r
 140      * @param y1 DOCUMENT ME!\r
 141      * @param width DOCUMENT ME!\r
 142      * @param height DOCUMENT ME!\r
 143      */\r
 144     public synchronized void drawBoxes(SequenceI seq, int start, int end, int x1, int y1,\r
 145         int width, int height)\r
 146     {\r
 147       int i = start;\r
 148       int length = seq.getLength();\r
 149 \r
 150       int curStart = -1;\r
 151       int curWidth = width;\r
 152 \r
 153       Color tempColour = null;\r
 154 \r
 155       while (i <= end)\r
 156       {\r
 157         resBoxColour = Color.white;\r
 158 \r
 159         if (i < length)\r
 160         {\r
 161           if (inCurrentSequenceGroup(i))\r
 162           {\r
 163             if (currentSequenceGroup.getDisplayBoxes())\r
 164             {\r
 165               getBoxColour(currentSequenceGroup.cs, seq, i);\r
 166             }\r
 167           }\r
 168           else if (av.getShowBoxes())\r
 169           {\r
 170             getBoxColour(av.globalColourScheme, seq, i);\r
 171           }\r
 172 \r
 173         }\r
 174 \r
 175           if (resBoxColour != tempColour)\r
 176           {\r
 177               if (tempColour != null)\r
 178               {\r
 179                   graphics.fillRect(x1 + (width * (curStart - start)), y1,\r
 180                       curWidth, height);\r
 181               }\r
 182 \r
 183               graphics.setColor(resBoxColour);\r
 184 \r
 185               curStart = i;\r
 186               curWidth = width;\r
 187               tempColour = resBoxColour;\r
 188           }\r
 189           else\r
 190           {\r
 191               curWidth += width;\r
 192           }\r
 193 \r
 194           i++;\r
 195       }\r
 196 \r
 197       graphics.fillRect(x1 + (width * (curStart - start)), y1, curWidth,\r
 198           height);\r
 199 \r
 200     }\r
 201 \r
 202     /**\r
 203      * DOCUMENT ME!\r
 204      *\r
 205      * @param seq DOCUMENT ME!\r
 206      * @param start DOCUMENT ME!\r
 207      * @param end DOCUMENT ME!\r
 208      * @param x1 DOCUMENT ME!\r
 209      * @param y1 DOCUMENT ME!\r
 210      * @param width DOCUMENT ME!\r
 211      * @param height DOCUMENT ME!\r
 212      */\r
 213     public void drawText(SequenceI seq, int start, int end, int x1, int y1,\r
 214                          int width, int height)\r
 215     {\r
 216       y1 += height - height / 5; // height/5 replaces pady\r
 217       int charOffset = 0;\r
 218       char s;\r
 219 \r
 220         if(end+1>=seq.getLength())\r
 221           end = seq.getLength()-1;\r
 222         graphics.setColor(Color.black);\r
 223 \r
 224 \r
 225         if(monospacedFont && av.showText && allGroups.length==0 && !av.getColourText())\r
 226         {\r
 227           graphics.drawString(seq.getSequence(start, end + 1), x1, y1);\r
 228         }\r
 229         else\r
 230         {\r
 231           for (int i = start; i <= end; i++)\r
 232           {\r
 233             graphics.setColor(Color.black);\r
 234             s = seq.getCharAt(i);\r
 235             if (!renderGaps && jalview.util.Comparison.isGap(s))\r
 236             {\r
 237               continue;\r
 238             }\r
 239 \r
 240             if (inCurrentSequenceGroup(i))\r
 241             {\r
 242               if (!currentSequenceGroup.getDisplayText())\r
 243               {\r
 244                 continue;\r
 245               }\r
 246 \r
 247               if (currentSequenceGroup.getColourText())\r
 248               {\r
 249                 getBoxColour(currentSequenceGroup.cs, seq, i);\r
 250                 graphics.setColor(resBoxColour.darker());\r
 251               }\r
 252             }\r
 253             else\r
 254             {\r
 255               if (!av.getShowText())\r
 256               {\r
 257                 continue;\r
 258               }\r
 259 \r
 260               if (av.getColourText())\r
 261               {\r
 262                 getBoxColour(av.globalColourScheme, seq, i);\r
 263 \r
 264                 if (av.getShowBoxes())\r
 265                 {\r
 266                   graphics.setColor(resBoxColour.darker());\r
 267                 }\r
 268                 else\r
 269                 {\r
 270                   graphics.setColor(resBoxColour);\r
 271                 }\r
 272               }\r
 273             }\r
 274 \r
 275             charOffset = (width - fm.charWidth(s)) / 2;\r
 276             graphics.drawString(String.valueOf(s),\r
 277                                 charOffset + x1 + width * (i - start),\r
 278                                 y1);\r
 279 \r
 280           }\r
 281         }\r
 282     }\r
 283 \r
 284     /**\r
 285      * DOCUMENT ME!\r
 286      *\r
 287      * @param res DOCUMENT ME!\r
 288      *\r
 289      * @return DOCUMENT ME!\r
 290      */\r
 291     boolean inCurrentSequenceGroup(int res)\r
 292     {\r
 293         if (allGroups == null)\r
 294         {\r
 295             return false;\r
 296         }\r
 297 \r
 298         for (int i = 0; i < allGroups.length; i++)\r
 299         {\r
 300             if ((allGroups[i].getStartRes() <= res) &&\r
 301                     (allGroups[i].getEndRes() >= res))\r
 302             {\r
 303                 currentSequenceGroup = allGroups[i];\r
 304 \r
 305                 return true;\r
 306             }\r
 307         }\r
 308 \r
 309         return false;\r
 310     }\r
 311 \r
 312     /**\r
 313      * DOCUMENT ME!\r
 314      *\r
 315      * @param seq DOCUMENT ME!\r
 316      * @param start DOCUMENT ME!\r
 317      * @param end DOCUMENT ME!\r
 318      * @param x1 DOCUMENT ME!\r
 319      * @param y1 DOCUMENT ME!\r
 320      * @param width DOCUMENT ME!\r
 321      * @param height DOCUMENT ME!\r
 322      */\r
 323     public void drawHighlightedText(SequenceI seq, int start, int end, int x1,\r
 324         int y1, int width, int height)\r
 325     {\r
 326         int pady = height / 5;\r
 327         int charOffset = 0;\r
 328         graphics.setColor(Color.BLACK);\r
 329         graphics.fillRect(x1, y1, width * (end - start + 1), height);\r
 330         graphics.setColor(Color.white);\r
 331 \r
 332         char s = '~';\r
 333 \r
 334         // Need to find the sequence position here.\r
 335         for (int i = start; i <= end; i++)\r
 336         {\r
 337             if (i < seq.getLength())\r
 338             {\r
 339                 s = seq.getSequence().charAt(i);\r
 340             }\r
 341 \r
 342             charOffset = (width - fm.charWidth(s)) / 2;\r
 343             graphics.drawString(String.valueOf(s),\r
 344                 charOffset + x1 + (width * (i - start)), (y1 + height) - pady);\r
 345         }\r
 346     }\r
 347 }\r