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.getResidueShading(),
  88             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(), avCharHeight = av
 123             .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,
 140                     i);
 141           }
 142         }
 143         else if (av.getShowBoxes())
 144         {
 145           resBoxColour = resColourFinder
 146                   .getBoxColour(av.getResidueShading(), seq, i);
 147         }
 148       }
 149
 150       if (resBoxColour != tempColour)
 151       {
 152         if (tempColour != null)
 153         {
 154           graphics.fillRect(avCharWidth * (curStart - start), y1, curWidth,
 155                   avCharHeight);
 156         }
 157         graphics.setColor(resBoxColour);
 158
 159         curStart = i;
 160         curWidth = avCharWidth;
 161         tempColour = resBoxColour;
 162
 163       }
 164       else
 165       {
 166         curWidth += avCharWidth;
 167       }
 168
 169       i++;
 170     }
 171
 172     graphics.fillRect(avCharWidth * (curStart - start), y1, curWidth,
 173             avCharHeight);
 174   }
 175
 176   public void drawText(SequenceI seq, int start, int end, int y1)
 177   {
 178     int avCharWidth = av.getCharWidth(), avCharHeight = av.getCharHeight();
 179     Font boldFont = null;
 180     boolean bold = false;
 181     if (av.isUpperCasebold())
 182     {
 183       boldFont = new Font(av.getFont().getName(), Font.BOLD, avCharHeight);
 184
 185       graphics.setFont(av.getFont());
 186     }
 187
 188     y1 += avCharHeight - avCharHeight / 5; // height/5 replaces pady
 189
 190     int charOffset = 0;
 191
 192     // Need to find the sequence position here.
 193     if (end + 1 >= seq.getLength())
 194     {
 195       end = seq.getLength() - 1;
 196     }
 197
 198     char s = ' ';
 199     boolean srep = av.isDisplayReferenceSeq();
 200     for (int i = start; i <= end; i++)
 201     {
 202       graphics.setColor(Color.black);
 203
 204       s = seq.getCharAt(i);
 205       if (!renderGaps && jalview.util.Comparison.isGap(s))
 206       {
 207         continue;
 208       }
 209
 210       SequenceGroup currentSequenceGroup = resColourFinder
 211               .getCurrentSequenceGroup(allGroups, i);
 212       if (currentSequenceGroup != null)
 213       {
 214         if (!currentSequenceGroup.getDisplayText())
 215         {
 216           continue;
 217         }
 218
 219         if (currentSequenceGroup.getColourText())
 220         {
 221           resBoxColour = resColourFinder.getBoxColour(
 222                   currentSequenceGroup.getGroupColourScheme(), seq, i);
 223           graphics.setColor(resBoxColour.darker());
 224         }
 225         if (currentSequenceGroup.getShowNonconserved())
 226         {
 227           s = getDisplayChar(srep, i, s, '.', currentSequenceGroup);
 228         }
 229       }
 230       else
 231       {
 232         if (!av.getShowText())
 233         {
 234           continue;
 235         }
 236
 237         if (av.getColourText())
 238         {
 239           resBoxColour = resColourFinder
 240                   .getBoxColour(av.getResidueShading(), seq, i);
 241           if (av.getShowBoxes())
 242           {
 243             graphics.setColor(resBoxColour.darker());
 244           }
 245           else
 246           {
 247             graphics.setColor(resBoxColour);
 248           }
 249         }
 250         if (av.getShowUnconserved())
 251         {
 252           s = getDisplayChar(srep, i, s, '.', null);
 253
 254         }
 255       }
 256
 257       if (av.isUpperCasebold())
 258       {
 259         fm = graphics.getFontMetrics();
 260         if ('A' <= s && s <= 'Z')
 261         {
 262           if (!bold)
 263           {
 264
 265             graphics.setFont(boldFont);
 266           }
 267           bold = true;
 268         }
 269         else if (bold)
 270         {
 271           graphics.setFont(av.font);
 272           bold = false;
 273         }
 274
 275       }
 276
 277       charOffset = (avCharWidth - fm.charWidth(s)) / 2;
 278       graphics.drawString(String.valueOf(s), charOffset + avCharWidth
 279               * (i - start), y1);
 280     }
 281
 282   }
 283
 284   /**
 285    * Returns 'conservedChar' to represent the given position if the sequence
 286    * character at that position is equal to the consensus (ignoring case), else
 287    * returns the sequence character
 288    *
 289    * @param usesrep
 290    * @param position
 291    * @param sequenceChar
 292    * @param conservedChar
 293    * @return
 294    */
 295   private char getDisplayChar(final boolean usesrep, int position,
 296           char sequenceChar, char conservedChar, SequenceGroup currentGroup)
 297   {
 298     // TODO - use currentSequenceGroup rather than alignment
 299     // currentSequenceGroup.getConsensus()
 300     char conschar = (usesrep) ? (currentGroup == null
 301             || position < currentGroup.getStartRes()
 302             || position > currentGroup.getEndRes() ? av.getAlignment()
 303             .getSeqrep().getCharAt(position)
 304             : (currentGroup.getSeqrep() != null ? currentGroup.getSeqrep()
 305                     .getCharAt(position) : av.getAlignment().getSeqrep()
 306                     .getCharAt(position)))
 307             : (currentGroup != null && currentGroup.getConsensus() != null
 308                     && position >= currentGroup.getStartRes()
 309                     && position <= currentGroup.getEndRes() && currentGroup
 310                     .getConsensus().annotations.length > position) ? currentGroup
 311                     .getConsensus().annotations[position].displayCharacter
 312                     .charAt(0)
 313                     : av.getAlignmentConsensusAnnotation().annotations[position].displayCharacter
 314                             .charAt(0);
 315     if (!jalview.util.Comparison.isGap(conschar)
 316             && (sequenceChar == conschar || sequenceChar + CHAR_TO_UPPER == conschar))
 317     {
 318       sequenceChar = conservedChar;
 319     }
 320     return sequenceChar;
 321   }
 322
 323   public void drawHighlightedText(SequenceI seq, int start, int end,
 324           int x1, int y1)
 325   {
 326     int avCharWidth = av.getCharWidth(), avCharHeight = av.getCharHeight();
 327     int pady = avCharHeight / 5;
 328     int charOffset = 0;
 329     graphics.setColor(Color.black);
 330     graphics.fillRect(x1, y1, avCharWidth * (end - start + 1), avCharHeight);
 331     graphics.setColor(Color.white);
 332
 333     char s = '~';
 334     // Need to find the sequence position here.
 335     if (av.validCharWidth)
 336     {
 337       for (int i = start; i <= end; i++)
 338       {
 339         if (i < seq.getLength())
 340         {
 341           s = seq.getCharAt(i);
 342         }
 343
 344         charOffset = (avCharWidth - fm.charWidth(s)) / 2;
 345         graphics.drawString(String.valueOf(s), charOffset + x1
 346                 + avCharWidth * (i - start), y1 + avCharHeight - pady);
 347       }
 348     }
 349   }
 350
 351   public void drawCursor(SequenceI seq, int res, int x1, int y1)
 352   {
 353     int pady = av.getCharHeight() / 5;
 354     int charOffset = 0;
 355     graphics.setColor(Color.black);
 356     graphics.fillRect(x1, y1, av.getCharWidth(), av.getCharHeight());
 357     graphics.setColor(Color.white);
 358
 359     graphics.setColor(Color.white);
 360
 361     char s = seq.getCharAt(res);
 362     if (av.validCharWidth)
 363     {
 364
 365       charOffset = (av.getCharWidth() - fm.charWidth(s)) / 2;
 366       graphics.drawString(String.valueOf(s), charOffset + x1,
 367               (y1 + av.getCharHeight()) - pady);
 368     }
 369   }
 370
 371 }