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 \r
  43     /**\r
  44      * Creates a new SequenceRenderer object.\r
  45      *\r
  46      * @param av DOCUMENT ME!\r
  47      */\r
  48     public SequenceRenderer(AlignViewport av)\r
  49     {\r
  50         this.av = av;\r
  51     }\r
  52 \r
  53     /**\r
  54      * DOCUMENT ME!\r
  55      *\r
  56      * @param b DOCUMENT ME!\r
  57      */\r
  58     public void renderGaps(boolean b)\r
  59     {\r
  60         renderGaps = b;\r
  61     }\r
  62 \r
  63 \r
  64     public Color getResidueBoxColour(SequenceI seq, int i)\r
  65     {\r
  66       allGroups = av.alignment.findAllGroups(seq);\r
  67 \r
  68       if (inCurrentSequenceGroup(i))\r
  69       {\r
  70         if (currentSequenceGroup.getDisplayBoxes())\r
  71         {\r
  72           getBoxColour(currentSequenceGroup.cs, seq, i);\r
  73         }\r
  74       }\r
  75       else if (av.getShowBoxes())\r
  76       {\r
  77           getBoxColour(av.globalColourScheme, seq, i);\r
  78       }\r
  79 \r
  80       return resBoxColour;\r
  81     }\r
  82 \r
  83 \r
  84     /**\r
  85      * DOCUMENT ME!\r
  86      *\r
  87      * @param cs DOCUMENT ME!\r
  88      * @param seq DOCUMENT ME!\r
  89      * @param i DOCUMENT ME!\r
  90      */\r
  91     void getBoxColour(ColourSchemeI cs, SequenceI seq, int i)\r
  92     {\r
  93         if (cs != null)\r
  94         {\r
  95             resBoxColour = cs.findColour(seq.getSequence(i, i + 1), i);\r
  96         }\r
  97         else\r
  98         {\r
  99             resBoxColour = Color.white;\r
 100         }\r
 101     }\r
 102 \r
 103     /**\r
 104      * DOCUMENT ME!\r
 105      *\r
 106      * @param g DOCUMENT ME!\r
 107      * @param seq DOCUMENT ME!\r
 108      * @param sg DOCUMENT ME!\r
 109      * @param start DOCUMENT ME!\r
 110      * @param end DOCUMENT ME!\r
 111      * @param x1 DOCUMENT ME!\r
 112      * @param y1 DOCUMENT ME!\r
 113      * @param width DOCUMENT ME!\r
 114      * @param height DOCUMENT ME!\r
 115      */\r
 116     public void drawSequence(Graphics g, SequenceI seq, SequenceGroup[] sg,\r
 117         int start, int end, int x1, int y1, int width, int height)\r
 118     {\r
 119         allGroups = sg;\r
 120 \r
 121         graphics = g;\r
 122 \r
 123         drawBoxes(seq, start, end, x1, y1, (int) width, height);\r
 124 \r
 125         fm = g.getFontMetrics();\r
 126         drawText(seq, start, end, x1, y1, (int) width, height);\r
 127     }\r
 128 \r
 129     /**\r
 130      * DOCUMENT ME!\r
 131      *\r
 132      * @param seq DOCUMENT ME!\r
 133      * @param start DOCUMENT ME!\r
 134      * @param end DOCUMENT ME!\r
 135      * @param x1 DOCUMENT ME!\r
 136      * @param y1 DOCUMENT ME!\r
 137      * @param width DOCUMENT ME!\r
 138      * @param height DOCUMENT ME!\r
 139      */\r
 140     public synchronized void drawBoxes(SequenceI seq, int start, int end, int x1, int y1,\r
 141         int width, int height)\r
 142     {\r
 143       int i = start;\r
 144       int length = seq.getLength();\r
 145 \r
 146       int curStart = -1;\r
 147       int curWidth = width;\r
 148 \r
 149       Color tempColour = null;\r
 150 \r
 151       while (i <= end)\r
 152       {\r
 153         resBoxColour = Color.white;\r
 154 \r
 155         if (i < length)\r
 156         {\r
 157           if (inCurrentSequenceGroup(i))\r
 158           {\r
 159             if (currentSequenceGroup.getDisplayBoxes())\r
 160             {\r
 161               getBoxColour(currentSequenceGroup.cs, seq, i);\r
 162             }\r
 163           }\r
 164           else if (av.getShowBoxes())\r
 165           {\r
 166             getBoxColour(av.globalColourScheme, seq, i);\r
 167           }\r
 168 \r
 169         }\r
 170 \r
 171           if (resBoxColour != tempColour)\r
 172           {\r
 173               if (tempColour != null)\r
 174               {\r
 175                   graphics.fillRect(x1 + (width * (curStart - start)), y1,\r
 176                       curWidth, height);\r
 177               }\r
 178 \r
 179               graphics.setColor(resBoxColour);\r
 180 \r
 181               curStart = i;\r
 182               curWidth = width;\r
 183               tempColour = resBoxColour;\r
 184           }\r
 185           else\r
 186           {\r
 187               curWidth += width;\r
 188           }\r
 189 \r
 190           i++;\r
 191       }\r
 192 \r
 193       graphics.fillRect(x1 + (width * (curStart - start)), y1, curWidth,\r
 194           height);\r
 195 \r
 196     }\r
 197 \r
 198     /**\r
 199      * DOCUMENT ME!\r
 200      *\r
 201      * @param seq DOCUMENT ME!\r
 202      * @param start DOCUMENT ME!\r
 203      * @param end DOCUMENT ME!\r
 204      * @param x1 DOCUMENT ME!\r
 205      * @param y1 DOCUMENT ME!\r
 206      * @param width DOCUMENT ME!\r
 207      * @param height DOCUMENT ME!\r
 208      */\r
 209     public void drawText(SequenceI seq, int start, int end, int x1, int y1,\r
 210         int width, int height)\r
 211     {\r
 212         int pady = height / 5;\r
 213         int charOffset = 0;\r
 214         char s;\r
 215 \r
 216 \r
 217         // Need to find the sequence position here.\r
 218         String sequence = seq.getSequence();\r
 219 \r
 220         if(end+1>=seq.getLength())\r
 221           end = seq.getLength()-1;\r
 222 \r
 223         for (int i = start; i <= end; i++)\r
 224         {\r
 225             graphics.setColor(Color.black);\r
 226 \r
 227             s = sequence.charAt(i);\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.globalColourScheme, 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 + (int)(width * (i - start)), (y1 + height) - pady);\r
 272 \r
 273         }\r
 274     }\r
 275 \r
 276     /**\r
 277      * DOCUMENT ME!\r
 278      *\r
 279      * @param res DOCUMENT ME!\r
 280      *\r
 281      * @return DOCUMENT ME!\r
 282      */\r
 283     boolean inCurrentSequenceGroup(int res)\r
 284     {\r
 285         if (allGroups == null)\r
 286         {\r
 287             return false;\r
 288         }\r
 289 \r
 290         for (int i = 0; i < allGroups.length; i++)\r
 291         {\r
 292             if ((allGroups[i].getStartRes() <= res) &&\r
 293                     (allGroups[i].getEndRes() >= res))\r
 294             {\r
 295                 currentSequenceGroup = allGroups[i];\r
 296 \r
 297                 return true;\r
 298             }\r
 299         }\r
 300 \r
 301         return false;\r
 302     }\r
 303 \r
 304     /**\r
 305      * DOCUMENT ME!\r
 306      *\r
 307      * @param seq DOCUMENT ME!\r
 308      * @param start DOCUMENT ME!\r
 309      * @param end DOCUMENT ME!\r
 310      * @param x1 DOCUMENT ME!\r
 311      * @param y1 DOCUMENT ME!\r
 312      * @param width DOCUMENT ME!\r
 313      * @param height DOCUMENT ME!\r
 314      */\r
 315     public void drawHighlightedText(SequenceI seq, int start, int end, int x1,\r
 316         int y1, int width, int height)\r
 317     {\r
 318         int pady = height / 5;\r
 319         int charOffset = 0;\r
 320         graphics.setColor(Color.BLACK);\r
 321         graphics.fillRect(x1, y1, width * (end - start + 1), height);\r
 322         graphics.setColor(Color.white);\r
 323 \r
 324         char s = '~';\r
 325 \r
 326         // Need to find the sequence position here.\r
 327         for (int i = start; i <= end; i++)\r
 328         {\r
 329             if (i < seq.getLength())\r
 330             {\r
 331                 s = seq.getSequence().charAt(i);\r
 332             }\r
 333 \r
 334             charOffset = (width - fm.charWidth(s)) / 2;\r
 335             graphics.drawString(String.valueOf(s),\r
 336                 charOffset + x1 + (width * (i - start)), (y1 + height) - pady);\r
 337         }\r
 338     }\r
 339 }\r