JAL-3215 refactored ScoreColourScheme construction for scriptability
[jalview.git] / src / jalview / schemes / BuriedColourScheme.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 import java.awt.Color;
27
28 /**
29  * A graduated colour scheme based on residue buried index score
30  */
31 public class BuriedColourScheme extends ScoreColourScheme
32 {
33   private static final Color minScoreColour = new Color(0, 255, 0);
34
35   private static final Color maxScoreColour = new Color(0, 0, 255);
36
37   /**
38    * Constructor
39    */
40   public BuriedColourScheme()
41   {
42     super(JalviewColourScheme.Buried.toString(), ResidueProperties.aaIndex,
43             ResidueProperties.buried, minScoreColour, maxScoreColour);
44   }
45
46   @Override
47   public boolean isPeptideSpecific()
48   {
49     return true;
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   {
60     return new BuriedColourScheme();
61   }
62 }