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