JAL-1834 removed quotes around truncated strings with ellipsis
[jalview.git] / src / jalview / schemes / ColourSchemeI.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 java.awt.Color;
24 import java.util.Map;
25
26 import jalview.datamodel.AlignmentI;
27 import jalview.datamodel.AnnotatedCollectionI;
28 import jalview.datamodel.SequenceCollectionI;
29 import jalview.datamodel.SequenceGroup;
30 import jalview.datamodel.SequenceI;
31
32 public interface ColourSchemeI
33 {
34   /**
35    * 
36    * @param c
37    * @return the colour for the given character
38    */
39   public Color findColour(char c);
40
41   /**
42    * 
43    * @param c
44    *          - sequence symbol or gap
45    * @param j
46    *          - position in seq
47    * @param seq
48    *          - sequence being coloured
49    * @return context dependent colour for the given symbol at the position in
50    *         the given sequence
51    */
52   public Color findColour(char c, int j, SequenceI seq);
53
54   /**
55    * assign the given consensus profile for the colourscheme
56    */
57   public void setConsensus(java.util.Hashtable[] h);
58
59   /**
60    * assign the given conservation to the colourscheme
61    * 
62    * @param c
63    */
64   public void setConservation(jalview.analysis.Conservation c);
65
66   /**
67    * enable or disable conservation shading for this colourscheme
68    * 
69    * @param conservationApplied
70    */
71   public void setConservationApplied(boolean conservationApplied);
72
73   /**
74    * 
75    * @return true if conservation shading is enabled for this colourscheme
76    */
77   public boolean conservationApplied();
78
79   /**
80    * set scale factor for bleaching of colour in unconserved regions
81    * 
82    * @param i
83    */
84   public void setConservationInc(int i);
85
86   /**
87    * 
88    * @return scale factor for bleaching colour in unconserved regions
89    */
90   public int getConservationInc();
91
92   /**
93    * 
94    * @return percentage identity threshold for applying colourscheme
95    */
96   public int getThreshold();
97
98   /**
99    * set percentage identity threshold and type of %age identity calculation for
100    * shading
101    * 
102    * @param ct
103    *          0..100 percentage identity for applying this colourscheme
104    * @param ignoreGaps
105    *          when true, calculate PID without including gapped positions
106    */
107   public void setThreshold(int ct, boolean ignoreGaps);
108
109   /**
110    * recalculate dependent data using the given sequence collection, taking
111    * account of hidden rows
112    * 
113    * @param alignment
114    * @param hiddenReps
115    */
116   public void alignmentChanged(AnnotatedCollectionI alignment,
117           Map<SequenceI, SequenceCollectionI> hiddenReps);
118
119   /**
120    * create a new instance of the colourscheme configured to colour the given
121    * connection
122    * 
123    * @param sg
124    * @param hiddenRepSequences
125    * @return copy of current scheme with any inherited settings transfered
126    */
127   public ColourSchemeI applyTo(AnnotatedCollectionI sg,
128           Map<SequenceI, SequenceCollectionI> hiddenRepSequences);
129
130 }