JAL-1683 replace year/version strings with tokens in source
[jalview.git] / src / jalview / api / FeatureRenderer.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.api;
22
23 import jalview.datamodel.SequenceFeature;
24 import jalview.datamodel.SequenceI;
25
26 import java.awt.Color;
27 import java.util.Hashtable;
28 import java.util.List;
29 import java.util.Map;
30
31 /**
32  * Abstract feature renderer interface
33  * 
34  * @author JimP
35  * 
36  */
37 public interface FeatureRenderer
38 {
39
40   Color findFeatureColour(Color col, SequenceI sequenceI, int r);
41
42   void featuresAdded();
43
44   Object getFeatureStyle(String ft);
45
46   void setColour(String ft, Object ggc);
47
48   AlignViewportI getViewport();
49
50   FeaturesDisplayedI getFeaturesDisplayed();
51
52   Map<String,Object> getFeatureColours();
53
54   void findAllFeatures(boolean newMadeVisible);
55
56   Map<String,Object> getDisplayedFeatureCols();
57
58   List<String> getFeatureGroups();
59
60   List<String> getGroups(boolean visible);
61
62   void setGroupVisibility(List<String> toset, boolean visible);
63
64   void setGroupVisibility(String group, boolean visible);
65
66   List<SequenceFeature> findFeaturesAtRes(SequenceI sequence, int res);
67
68   boolean isTransparencyAvailable();
69
70   String[] getDisplayedFeatureTypes();
71
72   String[] getDisplayedFeatureGroups();
73
74   void setAllVisible(List<String> featureTypes);
75
76   void setVisible(String featureType);
77
78 }