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     boolean monospacedFont;\r
  43     boolean forOverview = false;\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 prepare(Graphics g, boolean renderGaps)\r
  61     {\r
  62         graphics = g;\r
  63         fm = g.getFontMetrics();\r
  64         monospacedFont = fm.getStringBounds("M",g).getWidth()==fm.getStringBounds("|",g).getWidth();\r
  65         this.renderGaps = renderGaps;\r
  66     }\r
  67 \r
  68 \r
  69     public Color getResidueBoxColour(SequenceI seq, int i)\r
  70     {\r
  71       allGroups = av.alignment.findAllGroups(seq);\r
  72 \r
  73       if (inCurrentSequenceGroup(i))\r
  74       {\r
  75         if (currentSequenceGroup.getDisplayBoxes())\r
  76         {\r
  77           getBoxColour(currentSequenceGroup.cs, seq, i);\r
  78         }\r
  79       }\r
  80       else if (av.getShowBoxes())\r
  81       {\r
  82           getBoxColour(av.globalColourScheme, seq, i);\r
  83       }\r
  84 \r
  85       return resBoxColour;\r
  86     }\r
  87 \r
  88 \r
  89     /**\r
  90      * DOCUMENT ME!\r
  91      *\r
  92      * @param cs DOCUMENT ME!\r
  93      * @param seq DOCUMENT ME!\r
  94      * @param i DOCUMENT ME!\r
  95      */\r
  96     void getBoxColour(ColourSchemeI cs, SequenceI seq, int i)\r
  97     {\r
  98         if (cs != null)\r
  99         {\r
 100             resBoxColour = cs.findColour(seq.getSequence(i, i + 1), i);\r
 101         }\r
 102         else if(forOverview && !jalview.util.Comparison.isGap(seq.getCharAt(i)))\r
 103         {\r
 104             resBoxColour = Color.lightGray;\r
 105         }\r
 106         else\r
 107         {\r
 108           resBoxColour = Color.white;\r
 109         }\r
 110     }\r
 111 \r
 112     /**\r
 113      * DOCUMENT ME!\r
 114      *\r
 115      * @param g DOCUMENT ME!\r
 116      * @param seq DOCUMENT ME!\r
 117      * @param sg DOCUMENT ME!\r
 118      * @param start DOCUMENT ME!\r
 119      * @param end DOCUMENT ME!\r
 120      * @param x1 DOCUMENT ME!\r
 121      * @param y1 DOCUMENT ME!\r
 122      * @param width DOCUMENT ME!\r
 123      * @param height DOCUMENT ME!\r
 124      */\r
 125     public void drawSequence(SequenceI seq, SequenceGroup[] sg,\r
 126         int start, int end, int y1)\r
 127     {\r
 128         allGroups = sg;\r
 129 \r
 130         drawBoxes(seq, start, end, y1);\r
 131 \r
 132         drawText(seq, start, end, y1);\r
 133     }\r
 134 \r
 135     /**\r
 136      * DOCUMENT ME!\r
 137      *\r
 138      * @param seq DOCUMENT ME!\r
 139      * @param start DOCUMENT ME!\r
 140      * @param end DOCUMENT ME!\r
 141      * @param x1 DOCUMENT ME!\r
 142      * @param y1 DOCUMENT ME!\r
 143      * @param width DOCUMENT ME!\r
 144      * @param height DOCUMENT ME!\r
 145      */\r
 146     public synchronized void drawBoxes(SequenceI seq, int start, int end, int y1)\r
 147     {\r
 148       int i = start;\r
 149       int length = seq.getLength();\r
 150 \r
 151       int curStart = -1;\r
 152       int curWidth = av.charWidth;\r
 153 \r
 154       Color tempColour = null;\r
 155 \r
 156       while (i <= end)\r
 157       {\r
 158         resBoxColour = Color.white;\r
 159 \r
 160         if (i < length)\r
 161         {\r
 162           if (inCurrentSequenceGroup(i))\r
 163           {\r
 164             if (currentSequenceGroup.getDisplayBoxes())\r
 165             {\r
 166               getBoxColour(currentSequenceGroup.cs, seq, i);\r
 167             }\r
 168           }\r
 169           else if (av.getShowBoxes())\r
 170           {\r
 171             getBoxColour(av.globalColourScheme, seq, i);\r
 172           }\r
 173 \r
 174         }\r
 175 \r
 176           if (resBoxColour != tempColour)\r
 177           {\r
 178               if (tempColour != null)\r
 179               {\r
 180                   graphics.fillRect( av.charWidth * (curStart - start), y1,\r
 181                       curWidth, av.charHeight);\r
 182               }\r
 183 \r
 184               graphics.setColor(resBoxColour);\r
 185 \r
 186               curStart = i;\r
 187               curWidth = av.charWidth;\r
 188               tempColour = resBoxColour;\r
 189           }\r
 190           else\r
 191           {\r
 192               curWidth += av.charWidth;\r
 193           }\r
 194 \r
 195           i++;\r
 196       }\r
 197 \r
 198       graphics.fillRect( av.charWidth * (curStart - start), y1, curWidth,\r
 199           av.charHeight);\r
 200 \r
 201     }\r
 202 \r
 203     /**\r
 204      * DOCUMENT ME!\r
 205      *\r
 206      * @param seq DOCUMENT ME!\r
 207      * @param start DOCUMENT ME!\r
 208      * @param end DOCUMENT ME!\r
 209      * @param x1 DOCUMENT ME!\r
 210      * @param y1 DOCUMENT ME!\r
 211      * @param width DOCUMENT ME!\r
 212      * @param height DOCUMENT ME!\r
 213      */\r
 214     public void drawText(SequenceI seq, int start, int end, int y1)\r
 215     {\r
 216       y1 += av.charHeight - av.charHeight / 5; // height/5 replaces pady\r
 217       int charOffset = 0;\r
 218       char s;\r
 219 \r
 220         if(end+1>=seq.getLength())\r
 221           end = seq.getLength()-1;\r
 222         graphics.setColor(Color.black);\r
 223 \r
 224 \r
 225         if(monospacedFont && av.showText && allGroups.length==0 && !av.getColourText())\r
 226         {\r
 227           if(av.renderGaps)\r
 228           graphics.drawString(seq.getSequence(start, end + 1), 0, y1);\r
 229          else\r
 230          {\r
 231            char gap = av.getGapCharacter();\r
 232            graphics.drawString( seq.getSequence(start, end+1).replace(gap, ' '), 0, y1);\r
 233          }\r
 234         }\r
 235         else\r
 236         {\r
 237           for (int i = start; i <= end; i++)\r
 238           {\r
 239             graphics.setColor(Color.black);\r
 240             s = seq.getCharAt(i);\r
 241             if (!renderGaps && jalview.util.Comparison.isGap(s))\r
 242             {\r
 243               continue;\r
 244             }\r
 245 \r
 246             if (inCurrentSequenceGroup(i))\r
 247             {\r
 248               if (!currentSequenceGroup.getDisplayText())\r
 249               {\r
 250                 continue;\r
 251               }\r
 252 \r
 253               if (currentSequenceGroup.getColourText())\r
 254               {\r
 255                 getBoxColour(currentSequenceGroup.cs, seq, i);\r
 256                 graphics.setColor(resBoxColour.darker());\r
 257               }\r
 258             }\r
 259             else\r
 260             {\r
 261               if (!av.getShowText())\r
 262               {\r
 263                 continue;\r
 264               }\r
 265 \r
 266               if (av.getColourText())\r
 267               {\r
 268                 getBoxColour(av.globalColourScheme, seq, i);\r
 269 \r
 270                 if (av.getShowBoxes())\r
 271                 {\r
 272                   graphics.setColor(resBoxColour.darker());\r
 273                 }\r
 274                 else\r
 275                 {\r
 276                   graphics.setColor(resBoxColour);\r
 277                 }\r
 278               }\r
 279             }\r
 280 \r
 281             charOffset = (av.charWidth - fm.charWidth(s)) / 2;\r
 282 \r
 283           //  System.out.print(s);\r
 284             graphics.drawString(String.valueOf(s),\r
 285                                 charOffset + av.charWidth * (i - start),\r
 286                                 y1);\r
 287 \r
 288           }\r
 289         //  System.out.println("\n");\r
 290         }\r
 291     }\r
 292 \r
 293     /**\r
 294      * DOCUMENT ME!\r
 295      *\r
 296      * @param res DOCUMENT ME!\r
 297      *\r
 298      * @return DOCUMENT ME!\r
 299      */\r
 300     boolean inCurrentSequenceGroup(int res)\r
 301     {\r
 302         if (allGroups == null)\r
 303         {\r
 304             return false;\r
 305         }\r
 306 \r
 307         for (int i = 0; i < allGroups.length; i++)\r
 308         {\r
 309             if ((allGroups[i].getStartRes() <= res) &&\r
 310                     (allGroups[i].getEndRes() >= res))\r
 311             {\r
 312                 currentSequenceGroup = allGroups[i];\r
 313 \r
 314                 return true;\r
 315             }\r
 316         }\r
 317 \r
 318         return false;\r
 319     }\r
 320 \r
 321     /**\r
 322      * DOCUMENT ME!\r
 323      *\r
 324      * @param seq DOCUMENT ME!\r
 325      * @param start DOCUMENT ME!\r
 326      * @param end DOCUMENT ME!\r
 327      * @param x1 DOCUMENT ME!\r
 328      * @param y1 DOCUMENT ME!\r
 329      * @param width DOCUMENT ME!\r
 330      * @param height DOCUMENT ME!\r
 331      */\r
 332     public void drawHighlightedText(SequenceI seq, int start, int end, int x1, int y1)\r
 333     {\r
 334         int pady = av.charHeight / 5;\r
 335         int charOffset = 0;\r
 336         graphics.setColor(Color.BLACK);\r
 337         graphics.fillRect(x1, y1, av.charWidth * (end - start + 1), av.charHeight);\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 = (av.charWidth - fm.charWidth(s)) / 2;\r
 351             graphics.drawString(String.valueOf(s),\r
 352                 charOffset + x1 + (av.charWidth * (i - start)),\r
 353                 (y1 + av.charHeight) - pady);\r
 354         }\r
 355     }\r
 356 \r
 357     public void drawCursor(SequenceI seq, int res, int x1, int y1)\r
 358     {\r
 359       int pady = av.charHeight / 5;\r
 360       int charOffset = 0;\r
 361       graphics.setColor(Color.black);\r
 362       graphics.fillRect(x1, y1, av.charWidth, av.charHeight);\r
 363       graphics.setColor(Color.white);\r
 364 \r
 365       graphics.setColor(Color.white);\r
 366 \r
 367       char s = seq.getCharAt(res);\r
 368 \r
 369       charOffset = (av.charWidth - fm.charWidth(s)) / 2;\r
 370       graphics.drawString(String.valueOf(s),\r
 371                 charOffset + x1,\r
 372                 (y1 + av.charHeight) - pady);\r
 373 \r
 374 \r
 375     }\r
 376 }\r