src/jalview/schemes/IdColourScheme.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.schemes;
  22
  23 import jalview.api.AlignViewportI;
  24 import jalview.datamodel.AnnotatedCollectionI;
  25 import jalview.datamodel.SequenceCollectionI;
  26 import jalview.datamodel.SequenceI;
  27
  28 import java.awt.Color;
  29 import java.util.Map;
  30
  31 public class IdColourScheme implements ColourSchemeI
  32 {
  33   AlignViewportI view = null;
  34
  35   AnnotatedCollectionI coll = null;
  36
  37   public IdColourScheme()
  38   {
  39
  40   }
  41   public IdColourScheme(AlignViewportI view, AnnotatedCollectionI coll)
  42   {
  43     this.view = view;
  44     this.coll = coll;
  45   }
  46
  47
  48   @Override
  49   public String getSchemeName()
  50   {
  51     return JalviewColourScheme.IdColour.toString();
  52   }
  53
  54   /**
  55    * Returns a new instance of this colour scheme with which the given data may
  56    * be coloured
  57    */
  58   @Override
  59   public ColourSchemeI getInstance(AlignViewportI view,
  60           AnnotatedCollectionI coll)
  61   {
  62     return new IdColourScheme(view, coll);
  63   }
  64
  65   @Override
  66   public void alignmentChanged(AnnotatedCollectionI alignment,
  67           Map<SequenceI, SequenceCollectionI> hiddenReps)
  68   {
  69   }
  70
  71   @Override
  72   public Color findColour(char symbol, int position, SequenceI seq,
  73           String consensusResidue, float pid)
  74   {
  75     // rather than testing if coll is a sequence group, and if so looking at
  76     // ((SequenceGroup)coll).idColour
  77     // we always return the sequence ID colour, in case the user has customised
  78     // the displayed Id colour by right-clicking an internal node in the tree.
  79     return (view == null) ? Color.WHITE
  80             : view.getSequenceColour(seq).darker();
  81   }
  82
  83   @Override
  84   public boolean hasGapColour()
  85   {
  86     return false;
  87   }
  88
  89   @Override
  90   public boolean isApplicableTo(AnnotatedCollectionI ac)
  91   {
  92     return true;
  93   }
  94
  95   @Override
  96   public boolean isSimple()
  97   {
  98     // this is really a sequence colour
  99     return true;
 100   }
 101 }