JAL-3676 Documentation in Help for Java Console, Logging and Reporting Bugs
[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
26 /**
27  * Colourscheme that takes its colours from some other colourscheme
28  * 
29  * @author jimp
30  * 
31  */
32 public class FollowerColourScheme extends ResidueColourScheme
33 {
34
35   private ColourSchemeI colourScheme;
36
37   public ColourSchemeI getBaseColour()
38   {
39     return colourScheme;
40   }
41
42   @Override
43   public String getSchemeName()
44   {
45     return "Follower";
46   }
47
48   /**
49    * Returns a new instance of this colour scheme with which the given data may
50    * be coloured
51    */
52   @Override
53   public ColourSchemeI getInstance(AlignViewportI view,
54           AnnotatedCollectionI coll)
55   {
56     return new FollowerColourScheme();
57   }
58
59   protected ColourSchemeI getColourScheme()
60   {
61     return colourScheme;
62   }
63
64   protected void setColourScheme(ColourSchemeI colourScheme)
65   {
66     this.colourScheme = colourScheme;
67   }
68
69 }