JAL-3127 pass reference to AlignViewportI when creating an instance of ColourSchemeI
[jalview.git] / src / jalview / schemes / FollowerColourScheme.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.util.Map;
29
30 /**
31  * Colourscheme that takes its colours from some other colourscheme
32  * 
33  * @author jimp
34  * 
35  */
36 public class FollowerColourScheme extends ResidueColourScheme
37 {
38
39   private ColourSchemeI colourScheme;
40
41   public ColourSchemeI getBaseColour()
42   {
43     return colourScheme;
44   }
45
46   @Override
47   public String getSchemeName()
48   {
49     return "Follower";
50   }
51
52   /**
53    * Returns a new instance of this colour scheme with which the given data may
54    * be coloured
55    */
56   @Override
57   public ColourSchemeI getInstance(AlignViewportI view,
58           AnnotatedCollectionI coll,
59           Map<SequenceI, SequenceCollectionI> hrs)
60   {
61     return new FollowerColourScheme();
62   }
63
64   protected ColourSchemeI getColourScheme()
65   {
66     return colourScheme;
67   }
68
69   protected void setColourScheme(ColourSchemeI colourScheme)
70   {
71     this.colourScheme = colourScheme;
72   }
73
74 }