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