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 /**\r
  29  * DOCUMENT ME!\r
  30  *\r
  31  * @author $author$\r
  32  * @version $Revision$\r
  33  */\r
  34 public class SequenceRenderer\r
  35 {\r
  36     AlignViewport av;\r
  37     FontMetrics fm;\r
  38     boolean renderGaps = true;\r
  39     SequenceGroup currentSequenceGroup = null;\r
  40     SequenceGroup[] allGroups = null;\r
  41     Color resBoxColour;\r
  42     Graphics graphics;\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      * DOCUMENT ME!\r
  66      *\r
  67      * @param cs DOCUMENT ME!\r
  68      * @param seq DOCUMENT ME!\r
  69      * @param i DOCUMENT ME!\r
  70      *\r
  71      * @return DOCUMENT ME!\r
  72      */\r
  73     public Color getResidueBoxColour(ColourSchemeI cs, SequenceI seq, int i)\r
  74     {\r
  75         getBoxColour(cs, seq, i);\r
  76 \r
  77         return resBoxColour;\r
  78     }\r
  79 \r
  80     /**\r
  81      * DOCUMENT ME!\r
  82      *\r
  83      * @param cs DOCUMENT ME!\r
  84      * @param seq DOCUMENT ME!\r
  85      * @param i DOCUMENT ME!\r
  86      */\r
  87     void getBoxColour(ColourSchemeI cs, SequenceI seq, int i)\r
  88     {\r
  89         if (cs != null)\r
  90         {\r
  91             resBoxColour = cs.findColour(seq.getSequence(i, i + 1), i);\r
  92         }\r
  93         else\r
  94         {\r
  95             resBoxColour = Color.white;\r
  96         }\r
  97     }\r
  98 \r
  99     /**\r
 100      * DOCUMENT ME!\r
 101      *\r
 102      * @param g DOCUMENT ME!\r
 103      * @param seq DOCUMENT ME!\r
 104      * @param sg DOCUMENT ME!\r
 105      * @param start DOCUMENT ME!\r
 106      * @param end DOCUMENT ME!\r
 107      * @param x1 DOCUMENT ME!\r
 108      * @param y1 DOCUMENT ME!\r
 109      * @param width DOCUMENT ME!\r
 110      * @param height DOCUMENT ME!\r
 111      */\r
 112     public void drawSequence(Graphics g, SequenceI seq, SequenceGroup[] sg,\r
 113         int start, int end, int x1, int y1, int width, int height)\r
 114     {\r
 115         allGroups = sg;\r
 116 \r
 117         graphics = g;\r
 118 \r
 119         drawBoxes(seq, start, end, x1, y1, (int) width, height);\r
 120 \r
 121         fm = g.getFontMetrics();\r
 122         drawText(seq, start, end, x1, y1, (int) width, height);\r
 123     }\r
 124 \r
 125     /**\r
 126      * DOCUMENT ME!\r
 127      *\r
 128      * @param seq DOCUMENT ME!\r
 129      * @param start DOCUMENT ME!\r
 130      * @param end DOCUMENT ME!\r
 131      * @param x1 DOCUMENT ME!\r
 132      * @param y1 DOCUMENT ME!\r
 133      * @param width DOCUMENT ME!\r
 134      * @param height DOCUMENT ME!\r
 135      */\r
 136     public void drawBoxes(SequenceI seq, int start, int end, int x1, int y1,\r
 137         int width, int height)\r
 138     {\r
 139         int i = start;\r
 140         int length = seq.getLength();\r
 141 \r
 142         int curStart = -1;\r
 143         int curWidth = width;\r
 144 \r
 145         Color tempColour = null;\r
 146 \r
 147         while (i <= end)\r
 148         {\r
 149           resBoxColour = Color.white;\r
 150 \r
 151           if (i < length)\r
 152           {\r
 153             if (inCurrentSequenceGroup(i))\r
 154             {\r
 155               if (currentSequenceGroup.getDisplayBoxes())\r
 156               {\r
 157                 getBoxColour(currentSequenceGroup.cs, seq, i);\r
 158               }\r
 159             }\r
 160             else if (av.getShowBoxes())\r
 161             {\r
 162               getBoxColour(av.getGlobalColourScheme(), seq, i);\r
 163             }\r
 164 \r
 165           }\r
 166 \r
 167             if (resBoxColour != tempColour)\r
 168             {\r
 169                 if (tempColour != null)\r
 170                 {\r
 171                   int xxx = x1 + (int) (av.charWidth * (curStart - start));\r
 172                   if (width != av.charWidth)\r
 173                   {\r
 174                     xxx = x1 + (int) (av.charWidth * (curStart - start)) / 3;\r
 175                   }\r
 176 \r
 177 \r
 178                     graphics.fillRect(xxx, y1,\r
 179                         curWidth, height);\r
 180                 }\r
 181 \r
 182                 graphics.setColor(resBoxColour);\r
 183 \r
 184                 curStart = i;\r
 185                 curWidth = width;\r
 186                 tempColour = resBoxColour;\r
 187             }\r
 188             else\r
 189             {\r
 190                 curWidth += width;\r
 191             }\r
 192 \r
 193             i++;\r
 194         }\r
 195 \r
 196         int xxx = x1 + (int) (av.charWidth * (curStart - start));\r
 197         if (width != av.charWidth)\r
 198         {\r
 199           xxx = x1 + (int) (av.charWidth * (curStart - start)) / 3;\r
 200         }\r
 201 \r
 202 \r
 203         graphics.fillRect(xxx, y1, curWidth,\r
 204             height);\r
 205     }\r
 206 \r
 207     /**\r
 208      * DOCUMENT ME!\r
 209      *\r
 210      * @param seq DOCUMENT ME!\r
 211      * @param start DOCUMENT ME!\r
 212      * @param end DOCUMENT ME!\r
 213      * @param x1 DOCUMENT ME!\r
 214      * @param y1 DOCUMENT ME!\r
 215      * @param width DOCUMENT ME!\r
 216      * @param height DOCUMENT ME!\r
 217      */\r
 218     public void drawText(SequenceI seq, int start, int end, int x1, int y1,\r
 219         int width, int height)\r
 220     {\r
 221         int pady = height / 5;\r
 222         int charOffset = 0;\r
 223         char s;\r
 224 \r
 225 \r
 226         // Need to find the sequence position here.\r
 227         String sequence = seq.getSequence();\r
 228 \r
 229         if(end+1>=seq.getLength())\r
 230           end = seq.getLength()-1;\r
 231 \r
 232         for (int i = start; i <= end; i++)\r
 233         {\r
 234             graphics.setColor(Color.black);\r
 235 \r
 236             s = sequence.charAt(i);\r
 237 \r
 238             if (!renderGaps && jalview.util.Comparison.isGap(s))\r
 239             {\r
 240                 continue;\r
 241             }\r
 242 \r
 243             if (inCurrentSequenceGroup(i))\r
 244             {\r
 245                 if (!currentSequenceGroup.getDisplayText())\r
 246                 {\r
 247                     continue;\r
 248                 }\r
 249 \r
 250                 if (currentSequenceGroup.getColourText())\r
 251                 {\r
 252                     getBoxColour(currentSequenceGroup.cs, seq, i);\r
 253                     graphics.setColor(resBoxColour.darker());\r
 254                 }\r
 255             }\r
 256             else\r
 257             {\r
 258                 if (!av.getShowText())\r
 259                 {\r
 260                     continue;\r
 261                 }\r
 262 \r
 263                 if (av.getColourText())\r
 264                 {\r
 265                     getBoxColour(av.getGlobalColourScheme(), seq, i);\r
 266 \r
 267                     if (av.getShowBoxes())\r
 268                     {\r
 269                         graphics.setColor(resBoxColour.darker());\r
 270                     }\r
 271                     else\r
 272                     {\r
 273                         graphics.setColor(resBoxColour);\r
 274                     }\r
 275                 }\r
 276             }\r
 277 \r
 278             charOffset = (width - fm.charWidth(s)) / 2;\r
 279 \r
 280             int xxx = charOffset + x1 + (int)(av.charWidth * (i - start));\r
 281             if(width != av.charWidth)\r
 282             {\r
 283               xxx = charOffset + x1 + (int)(av.charWidth * (i - start))/3;\r
 284             }\r
 285 \r
 286             graphics.drawString(String.valueOf(s),xxx, (y1 + height) - pady);\r
 287         }\r
 288     }\r
 289 \r
 290     /**\r
 291      * DOCUMENT ME!\r
 292      *\r
 293      * @param res DOCUMENT ME!\r
 294      *\r
 295      * @return DOCUMENT ME!\r
 296      */\r
 297     boolean inCurrentSequenceGroup(int res)\r
 298     {\r
 299         if (allGroups == null)\r
 300         {\r
 301             return false;\r
 302         }\r
 303 \r
 304         for (int i = 0; i < allGroups.length; i++)\r
 305         {\r
 306             if ((allGroups[i].getStartRes() <= res) &&\r
 307                     (allGroups[i].getEndRes() >= res))\r
 308             {\r
 309                 currentSequenceGroup = allGroups[i];\r
 310 \r
 311                 return true;\r
 312             }\r
 313         }\r
 314 \r
 315         return false;\r
 316     }\r
 317 \r
 318     /**\r
 319      * DOCUMENT ME!\r
 320      *\r
 321      * @param seq DOCUMENT ME!\r
 322      * @param start DOCUMENT ME!\r
 323      * @param end DOCUMENT ME!\r
 324      * @param x1 DOCUMENT ME!\r
 325      * @param y1 DOCUMENT ME!\r
 326      * @param width DOCUMENT ME!\r
 327      * @param height DOCUMENT ME!\r
 328      */\r
 329     public void drawHighlightedText(SequenceI seq, int start, int end, int x1,\r
 330         int y1, int width, int height)\r
 331     {\r
 332         int pady = height / 5;\r
 333         int charOffset = 0;\r
 334         graphics.setColor(Color.BLACK);\r
 335         graphics.fillRect(x1, y1, width * (end - start + 1), height);\r
 336         graphics.setColor(Color.white);\r
 337 \r
 338         char s = '~';\r
 339 \r
 340         // Need to find the sequence position here.\r
 341         for (int i = start; i <= end; i++)\r
 342         {\r
 343             if (i < seq.getLength())\r
 344             {\r
 345                 s = seq.getSequence().charAt(i);\r
 346             }\r
 347 \r
 348             charOffset = (width - fm.charWidth(s)) / 2;\r
 349             graphics.drawString(String.valueOf(s),\r
 350                 charOffset + x1 + (width * (i - start)), (y1 + height) - pady);\r
 351         }\r
 352     }\r
 353 }\r