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           Map<SequenceI, SequenceCollectionI> hrs)
  62   {
  63     return new IdColourScheme(view, coll);
  64   }
  65
  66   @Override
  67   public void alignmentChanged(AnnotatedCollectionI alignment,
  68           Map<SequenceI, SequenceCollectionI> hiddenReps)
  69   {
  70   }
  71
  72   @Override
  73   public Color findColour(char symbol, int position, SequenceI seq,
  74           String consensusResidue, float pid)
  75   {
  76     // rather than testing if coll is a sequence group, and if so looking at
  77     // ((SequenceGroup)coll).idColour
  78     // we always return the sequence ID colour, in case the user has customised
  79     // the displayed Id colour by right-clicking an internal node in the tree.
  80     return (view == null) ? Color.WHITE
  81             : view.getSequenceColour(seq).darker();
  82   }
  83
  84   @Override
  85   public boolean hasGapColour()
  86   {
  87     return false;
  88   }
  89
  90   @Override
  91   public boolean isApplicableTo(AnnotatedCollectionI ac)
  92   {
  93     return true;
  94   }
  95
  96   @Override
  97   public boolean isSimple()
  98   {
  99     // this is really a sequence colour
 100     return true;
 101   }
 102 }