src/jalview/api/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.api;
  22
  23 import jalview.datamodel.SequenceGroup;
  24 import jalview.datamodel.SequenceI;
  25 import jalview.renderer.seqfeatures.FeatureColourFinder;
  26
  27 import java.awt.Color;
  28 import java.awt.Graphics;
  29
  30 public interface SequenceRenderer
  31 {
  32
  33   Color getResidueColour(SequenceI seq, int position,
  34           FeatureColourFinder finder);
  35
  36   /**
  37    * Configure the Graphics canvas and render options for the renderer
  38    *
  39    * @param g
  40    *          - the canvas to render to
  41    * @param renderGaps
  42    *          - when true, gap characters will be included when rendered
  43    *
  44    */
  45   void prepare(Graphics g, boolean renderGaps);
  46
  47   void drawSequence(SequenceI nextSeq, SequenceGroup[] findAllGroups,
  48           int startRes, int endRes, int i);
  49
  50   void drawHighlightedText(SequenceI nextSeq, int i, int j, int k, int l);
  51
  52   void drawCursor(Graphics g, char s, int i, int j);
  53
  54 }