src/jalview/appletgui/SequenceRenderer.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.appletgui;
  22
  23 import jalview.datamodel.SequenceGroup;
  24 import jalview.datamodel.SequenceI;
  25 import jalview.renderer.ResidueColourFinder;
  26 import jalview.renderer.seqfeatures.FeatureColourFinder;
  27
  28 import java.awt.Color;
  29 import java.awt.Font;
  30 import java.awt.FontMetrics;
  31 import java.awt.Graphics;
  32
  33 public class SequenceRenderer implements jalview.api.SequenceRenderer
  34 {
  35   final static int CHAR_TO_UPPER = 'A' - 'a';
  36
  37   AlignViewport av;
  38
  39   FontMetrics fm;
  40
  41   boolean renderGaps = true;
  42
  43   SequenceGroup[] allGroups = null;
  44
  45   Color resBoxColour;
  46
  47   Graphics graphics;
  48
  49   ResidueColourFinder resColourFinder;
  50
  51   public SequenceRenderer(AlignViewport av)
  52   {
  53     this.av = av;
  54     resColourFinder = new ResidueColourFinder();
  55   }
  56
  57   /**
  58    * DOCUMENT ME!
  59    *
  60    * @param b
  61    *          DOCUMENT ME!
  62    */
  63   public void prepare(Graphics g, boolean renderGaps)
  64   {
  65     graphics = g;
  66     fm = g.getFontMetrics();
  67
  68     this.renderGaps = renderGaps;
  69   }
  70
  71   /**
  72    * Get the residue colour at the given sequence position - as determined by
  73    * the sequence group colour (if any), else the colour scheme, possibly
  74    * overridden by a feature colour.
  75    *
  76    * @param seq
  77    * @param position
  78    * @param finder
  79    * @return
  80    */
  81   @Override
  82   public Color getResidueColour(final SequenceI seq, int position,
  83           FeatureColourFinder finder)
  84   {
  85     // TODO replace 8 or so code duplications with calls to this method
  86     // (refactored as needed)
  87     return resColourFinder.getResidueColour(av.getShowBoxes(),
  88             av.getResidueShading(), allGroups, seq, position, finder);
  89   }
  90
  91   public Color findSequenceColour(SequenceI seq, int i)
  92   {
  93     allGroups = av.getAlignment().findAllGroups(seq);
  94     drawBoxes(seq, i, i, 0);
  95     return resBoxColour;
  96   }
  97
  98   public void drawSequence(SequenceI seq, SequenceGroup[] sg, int start,
  99           int end, int y1)
 100   {
 101     if (seq == null)
 102     {
 103       return;
 104     }
 105
 106     allGroups = sg;
 107
 108     drawBoxes(seq, start, end, y1);
 109
 110     if (av.validCharWidth)
 111     {
 112       drawText(seq, start, end, y1);
 113     }
 114   }
 115
 116   public void drawBoxes(SequenceI seq, int start, int end, int y1)
 117   {
 118     int i = start;
 119     int length = seq.getLength();
 120
 121     int curStart = -1;
 122     int curWidth = av.getCharWidth(), avCharWidth = av.getCharWidth(),
 123             avCharHeight = av.getCharHeight();
 124
 125     Color resBoxColour = Color.white;
 126     Color tempColour = null;
 127     while (i <= end)
 128     {
 129       resBoxColour = Color.white;
 130       if (i < length)
 131       {
 132         SequenceGroup currentSequenceGroup = resColourFinder
 133                 .getCurrentSequenceGroup(allGroups, i);
 134         if (currentSequenceGroup != null)
 135         {
 136           if (currentSequenceGroup.getDisplayBoxes())
 137           {
 138             resBoxColour = resColourFinder.getBoxColour(
 139                     currentSequenceGroup.getGroupColourScheme(), seq, i);
 140           }
 141         }
 142         else if (av.getShowBoxes())
 143         {
 144           resBoxColour = resColourFinder
 145                   .getBoxColour(av.getResidueShading(), seq, i);
 146         }
 147       }
 148
 149       if (resBoxColour != tempColour)
 150       {
 151         if (tempColour != null)
 152         {
 153           graphics.fillRect(avCharWidth * (curStart - start), y1, curWidth,
 154                   avCharHeight);
 155         }
 156         graphics.setColor(resBoxColour);
 157
 158         curStart = i;
 159         curWidth = avCharWidth;
 160         tempColour = resBoxColour;
 161
 162       }
 163       else
 164       {
 165         curWidth += avCharWidth;
 166       }
 167
 168       i++;
 169     }
 170
 171     graphics.fillRect(avCharWidth * (curStart - start), y1, curWidth,
 172             avCharHeight);
 173   }
 174
 175   public void drawText(SequenceI seq, int start, int end, int y1)
 176   {
 177     int avCharWidth = av.getCharWidth(), avCharHeight = av.getCharHeight();
 178     Font boldFont = null;
 179     boolean bold = false;
 180     if (av.isUpperCasebold())
 181     {
 182       boldFont = new Font(av.getFont().getName(), Font.BOLD, avCharHeight);
 183
 184       graphics.setFont(av.getFont());
 185     }
 186
 187     y1 += avCharHeight - avCharHeight / 5; // height/5 replaces pady
 188
 189     int charOffset = 0;
 190
 191     // Need to find the sequence position here.
 192     if (end + 1 >= seq.getLength())
 193     {
 194       end = seq.getLength() - 1;
 195     }
 196
 197     char s = ' ';
 198     boolean srep = av.isDisplayReferenceSeq();
 199     for (int i = start; i <= end; i++)
 200     {
 201       graphics.setColor(Color.black);
 202
 203       s = seq.getCharAt(i);
 204       if (!renderGaps && jalview.util.Comparison.isGap(s))
 205       {
 206         continue;
 207       }
 208
 209       SequenceGroup currentSequenceGroup = resColourFinder
 210               .getCurrentSequenceGroup(allGroups, i);
 211       if (currentSequenceGroup != null)
 212       {
 213         if (!currentSequenceGroup.getDisplayText())
 214         {
 215           continue;
 216         }
 217
 218         if (currentSequenceGroup.getColourText())
 219         {
 220           resBoxColour = resColourFinder.getBoxColour(
 221                   currentSequenceGroup.getGroupColourScheme(), seq, i);
 222           graphics.setColor(resBoxColour.darker());
 223         }
 224         if (currentSequenceGroup.getShowNonconserved())
 225         {
 226           s = getDisplayChar(srep, i, s, '.', currentSequenceGroup);
 227         }
 228       }
 229       else
 230       {
 231         if (!av.getShowText())
 232         {
 233           continue;
 234         }
 235
 236         if (av.getColourText())
 237         {
 238           resBoxColour = resColourFinder
 239                   .getBoxColour(av.getResidueShading(), seq, i);
 240           if (av.getShowBoxes())
 241           {
 242             graphics.setColor(resBoxColour.darker());
 243           }
 244           else
 245           {
 246             graphics.setColor(resBoxColour);
 247           }
 248         }
 249         if (av.getShowUnconserved())
 250         {
 251           s = getDisplayChar(srep, i, s, '.', null);
 252
 253         }
 254       }
 255
 256       if (av.isUpperCasebold())
 257       {
 258         fm = graphics.getFontMetrics();
 259         if ('A' <= s && s <= 'Z')
 260         {
 261           if (!bold)
 262           {
 263
 264             graphics.setFont(boldFont);
 265           }
 266           bold = true;
 267         }
 268         else if (bold)
 269         {
 270           graphics.setFont(av.font);
 271           bold = false;
 272         }
 273
 274       }
 275
 276       charOffset = (avCharWidth - fm.charWidth(s)) / 2;
 277       graphics.drawString(String.valueOf(s),
 278               charOffset + avCharWidth * (i - start), y1);
 279     }
 280
 281   }
 282
 283   /**
 284    * Returns 'conservedChar' to represent the given position if the sequence
 285    * character at that position is equal to the consensus (ignoring case), else
 286    * returns the sequence character
 287    *
 288    * @param usesrep
 289    * @param position
 290    * @param sequenceChar
 291    * @param conservedChar
 292    * @return
 293    */
 294   private char getDisplayChar(final boolean usesrep, int position,
 295           char sequenceChar, char conservedChar, SequenceGroup currentGroup)
 296   {
 297     // TODO - use currentSequenceGroup rather than alignment
 298     // currentSequenceGroup.getConsensus()
 299     char conschar = (usesrep) ? (currentGroup == null
 300             || position < currentGroup.getStartRes()
 301             || position > currentGroup.getEndRes()
 302                     ? av.getAlignment().getSeqrep().getCharAt(position)
 303                     : (currentGroup.getSeqrep() != null
 304                             ? currentGroup.getSeqrep().getCharAt(position)
 305                             : av.getAlignment().getSeqrep()
 306                                     .getCharAt(position)))
 307             : (currentGroup != null && currentGroup.getConsensus() != null
 308                     && position >= currentGroup.getStartRes()
 309                     && position <= currentGroup.getEndRes()
 310                     && currentGroup
 311                             .getConsensus().annotations.length > position)
 312                                     ? currentGroup
 313                                             .getConsensus().annotations[position].displayCharacter
 314                                                     .charAt(0)
 315                                     : av.getAlignmentConsensusAnnotation().annotations[position].displayCharacter
 316                                             .charAt(0);
 317     if (!jalview.util.Comparison.isGap(conschar)
 318             && (sequenceChar == conschar
 319                     || sequenceChar + CHAR_TO_UPPER == conschar))
 320     {
 321       sequenceChar = conservedChar;
 322     }
 323     return sequenceChar;
 324   }
 325
 326   public void drawHighlightedText(SequenceI seq, int start, int end, int x1,
 327           int y1)
 328   {
 329     int avCharWidth = av.getCharWidth(), avCharHeight = av.getCharHeight();
 330     int pady = avCharHeight / 5;
 331     int charOffset = 0;
 332     graphics.setColor(Color.black);
 333     graphics.fillRect(x1, y1, avCharWidth * (end - start + 1),
 334             avCharHeight);
 335     graphics.setColor(Color.white);
 336
 337     char s = '~';
 338     // Need to find the sequence position here.
 339     if (av.validCharWidth)
 340     {
 341       for (int i = start; i <= end; i++)
 342       {
 343         if (i < seq.getLength())
 344         {
 345           s = seq.getCharAt(i);
 346         }
 347
 348         charOffset = (avCharWidth - fm.charWidth(s)) / 2;
 349         graphics.drawString(String.valueOf(s),
 350                 charOffset + x1 + avCharWidth * (i - start),
 351                 y1 + avCharHeight - pady);
 352       }
 353     }
 354   }
 355
 356   public void drawCursor(SequenceI seq, int res, int x1, int y1)
 357   {
 358     int pady = av.getCharHeight() / 5;
 359     int charOffset = 0;
 360     graphics.setColor(Color.black);
 361     graphics.fillRect(x1, y1, av.getCharWidth(), av.getCharHeight());
 362     graphics.setColor(Color.white);
 363
 364     graphics.setColor(Color.white);
 365
 366     char s = seq.getCharAt(res);
 367     if (av.validCharWidth)
 368     {
 369
 370       charOffset = (av.getCharWidth() - fm.charWidth(s)) / 2;
 371       graphics.drawString(String.valueOf(s), charOffset + x1,
 372               (y1 + av.getCharHeight()) - pady);
 373     }
 374   }
 375
 376 }