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) && (i < length))\r
 148         {\r
 149             if (inCurrentSequenceGroup(i))\r
 150             {\r
 151                 if (currentSequenceGroup.getDisplayBoxes())\r
 152                 {\r
 153                     getBoxColour(currentSequenceGroup.cs, seq, i);\r
 154                 }\r
 155                 else\r
 156                 {\r
 157                     resBoxColour = Color.white;\r
 158                 }\r
 159             }\r
 160             else if (av.getShowBoxes())\r
 161             {\r
 162                 getBoxColour(av.getGlobalColourScheme(), seq, i);\r
 163             }\r
 164             else\r
 165             {\r
 166                 resBoxColour = Color.white;\r
 167             }\r
 168 \r
 169             if (resBoxColour != tempColour)\r
 170             {\r
 171                 if (tempColour != null)\r
 172                 {\r
 173                     graphics.fillRect(x1 + (width * (curStart - start)), y1,\r
 174                         curWidth, height);\r
 175                 }\r
 176 \r
 177                 graphics.setColor(resBoxColour);\r
 178 \r
 179                 curStart = i;\r
 180                 curWidth = width;\r
 181                 tempColour = resBoxColour;\r
 182             }\r
 183             else\r
 184             {\r
 185                 curWidth += width;\r
 186             }\r
 187 \r
 188             i++;\r
 189         }\r
 190 \r
 191         graphics.fillRect(x1 + (width * (curStart - start)), y1, curWidth,\r
 192             height);\r
 193     }\r
 194 \r
 195     /**\r
 196      * DOCUMENT ME!\r
 197      *\r
 198      * @param seq DOCUMENT ME!\r
 199      * @param start DOCUMENT ME!\r
 200      * @param end DOCUMENT ME!\r
 201      * @param x1 DOCUMENT ME!\r
 202      * @param y1 DOCUMENT ME!\r
 203      * @param width DOCUMENT ME!\r
 204      * @param height DOCUMENT ME!\r
 205      */\r
 206     public void drawText(SequenceI seq, int start, int end, int x1, int y1,\r
 207         int width, int height)\r
 208     {\r
 209         int pady = height / 5;\r
 210         int charOffset = 0;\r
 211         char s;\r
 212 \r
 213         // Need to find the sequence position here.\r
 214         String sequence = seq.getSequence();\r
 215 \r
 216         for (int i = start; i <= end; i++)\r
 217         {\r
 218             graphics.setColor(Color.black);\r
 219 \r
 220             if (i < sequence.length())\r
 221             {\r
 222                 s = sequence.charAt(i);\r
 223             }\r
 224             else\r
 225             {\r
 226                 s = ' ';\r
 227             }\r
 228 \r
 229             if (!renderGaps && jalview.util.Comparison.isGap(s))\r
 230             {\r
 231                 continue;\r
 232             }\r
 233 \r
 234             if (inCurrentSequenceGroup(i))\r
 235             {\r
 236                 if (!currentSequenceGroup.getDisplayText())\r
 237                 {\r
 238                     continue;\r
 239                 }\r
 240 \r
 241                 if (currentSequenceGroup.getColourText())\r
 242                 {\r
 243                     getBoxColour(currentSequenceGroup.cs, seq, i);\r
 244                     graphics.setColor(resBoxColour.darker());\r
 245                 }\r
 246             }\r
 247             else\r
 248             {\r
 249                 if (!av.getShowText())\r
 250                 {\r
 251                     continue;\r
 252                 }\r
 253 \r
 254                 if (av.getColourText())\r
 255                 {\r
 256                     getBoxColour(av.getGlobalColourScheme(), seq, i);\r
 257 \r
 258                     if (av.getShowBoxes())\r
 259                     {\r
 260                         graphics.setColor(resBoxColour.darker());\r
 261                     }\r
 262                     else\r
 263                     {\r
 264                         graphics.setColor(resBoxColour);\r
 265                     }\r
 266                 }\r
 267             }\r
 268 \r
 269             charOffset = (width - fm.charWidth(s)) / 2;\r
 270             graphics.drawString(String.valueOf(s),\r
 271                 charOffset + x1 + (width * (i - start)), (y1 + height) - pady);\r
 272         }\r
 273     }\r
 274 \r
 275     /**\r
 276      * DOCUMENT ME!\r
 277      *\r
 278      * @param res DOCUMENT ME!\r
 279      *\r
 280      * @return DOCUMENT ME!\r
 281      */\r
 282     boolean inCurrentSequenceGroup(int res)\r
 283     {\r
 284         if (allGroups == null)\r
 285         {\r
 286             return false;\r
 287         }\r
 288 \r
 289         for (int i = 0; i < allGroups.length; i++)\r
 290         {\r
 291             if ((allGroups[i].getStartRes() <= res) &&\r
 292                     (allGroups[i].getEndRes() >= res))\r
 293             {\r
 294                 currentSequenceGroup = allGroups[i];\r
 295 \r
 296                 return true;\r
 297             }\r
 298         }\r
 299 \r
 300         return false;\r
 301     }\r
 302 \r
 303     /**\r
 304      * DOCUMENT ME!\r
 305      *\r
 306      * @param seq DOCUMENT ME!\r
 307      * @param start DOCUMENT ME!\r
 308      * @param end DOCUMENT ME!\r
 309      * @param x1 DOCUMENT ME!\r
 310      * @param y1 DOCUMENT ME!\r
 311      * @param width DOCUMENT ME!\r
 312      * @param height DOCUMENT ME!\r
 313      */\r
 314     public void drawHighlightedText(SequenceI seq, int start, int end, int x1,\r
 315         int y1, int width, int height)\r
 316     {\r
 317         int pady = height / 5;\r
 318         int charOffset = 0;\r
 319         graphics.setColor(Color.BLACK);\r
 320         graphics.fillRect(x1, y1, width * (end - start + 1), height);\r
 321         graphics.setColor(Color.white);\r
 322 \r
 323         char s = '~';\r
 324 \r
 325         // Need to find the sequence position here.\r
 326         for (int i = start; i <= end; i++)\r
 327         {\r
 328             if (i < seq.getLength())\r
 329             {\r
 330                 s = seq.getSequence().charAt(i);\r
 331             }\r
 332 \r
 333             charOffset = (width - fm.charWidth(s)) / 2;\r
 334             graphics.drawString(String.valueOf(s),\r
 335                 charOffset + x1 + (width * (i - start)), (y1 + height) - pady);\r
 336         }\r
 337     }\r
 338 }\r