JAL-1807 Bob's JalviewJS prototype first commit
[jalviewjs.git] / src / jalview / api / ViewStyleI.java
1 package jalview.api;
2
3 import java.awt.Color;
4
5 public interface ViewStyleI
6 {
7
8   void setColourAppliesToAllGroups(boolean b);
9
10   boolean getColourAppliesToAllGroups();
11
12   boolean getAbovePIDThreshold();
13
14   void setIncrement(int inc);
15
16   int getIncrement();
17
18   boolean getConservationSelected();
19
20   void setConservationSelected(boolean b);
21
22   void setShowHiddenMarkers(boolean show);
23
24   boolean getShowHiddenMarkers();
25
26   void setScaleRightWrapped(boolean b);
27
28   void setScaleLeftWrapped(boolean b);
29
30   void setScaleAboveWrapped(boolean b);
31
32   boolean getScaleLeftWrapped();
33
34   boolean getScaleAboveWrapped();
35
36   boolean getScaleRightWrapped();
37
38   void setAbovePIDThreshold(boolean b);
39
40   void setThreshold(int thresh);
41
42   int getThreshold();
43
44   boolean getShowJVSuffix();
45
46   void setShowJVSuffix(boolean b);
47
48   void setWrapAlignment(boolean state);
49
50   void setShowText(boolean state);
51
52   void setRenderGaps(boolean state);
53
54   boolean getColourText();
55
56   void setColourText(boolean state);
57
58   void setShowBoxes(boolean state);
59
60   boolean getWrapAlignment();
61
62   boolean getShowText();
63
64   int getWrappedWidth();
65
66   void setWrappedWidth(int w);
67
68   int getCharHeight();
69
70   void setCharHeight(int h);
71
72   int getCharWidth();
73
74   void setCharWidth(int w);
75
76   boolean getShowBoxes();
77
78   boolean getShowUnconserved();
79
80   void setShowUnconserved(boolean showunconserved);
81
82   /**
83    * @return true if a reference sequence is set and should be displayed
84    */
85   boolean isDisplayReferenceSeq();
86
87   /**
88    * @return set the flag for displaying reference sequences when they are
89    *         available
90    */
91   void setDisplayReferenceSeq(boolean displayReferenceSeq);
92
93   /**
94    * @return true if colourschemes should render according to reference sequence
95    *         rather than consensus if available
96    */
97   boolean isColourByReferenceSeq();
98
99   void setSeqNameItalics(boolean default1);
100
101   void setShowSequenceFeatures(boolean b);
102
103   boolean isShowSequenceFeatures();
104
105   boolean isRightAlignIds();
106
107   void setRightAlignIds(boolean rightAlignIds);
108
109   /**
110    * Returns true if annotation panel should be shown below alignment
111    * 
112    * @return
113    */
114   boolean isShowAnnotation();
115
116   /**
117    * Set flag for whether annotation panel should be shown below alignment
118    * 
119    * @param b
120    */
121   void setShowAnnotation(boolean b);
122
123   void setShowSequenceFeaturesHeight(boolean selected);
124
125   /**
126    * @return true set flag for deciding if colourschemes should render according
127    *         to reference sequence rather than consensus if available
128    */
129   void setColourByReferenceSeq(boolean colourByReferenceSeq);
130
131   Color getTextColour();
132
133   Color getTextColour2();
134
135   int getThresholdTextColour();
136
137   boolean isConservationColourSelected();
138
139   boolean isRenderGaps();
140
141   boolean isShowColourText();
142
143   boolean isShowSequenceFeaturesHeight();
144
145   void setConservationColourSelected(boolean conservationColourSelected);
146
147   void setShowColourText(boolean showColourText);
148
149   void setTextColour(Color textColour);
150
151   void setThresholdTextColour(int thresholdTextColour);
152
153   void setTextColour2(Color textColour2);
154
155   boolean isSeqNameItalics();
156
157   void setUpperCasebold(boolean upperCasebold);
158
159   boolean isUpperCasebold();
160   
161   boolean sameStyle(ViewStyleI them);
162
163   void setFontName(String name);
164
165   void setFontStyle(int style);
166
167   void setFontSize(int size);
168
169   int getFontStyle();
170
171   String getFontName();
172
173   int getFontSize();
174
175   /**
176    * @return width of Sequence and Annotation ID margin. If less than zero, then
177    *         width will be autocalculated
178    */
179   int getIdWidth();
180
181   /**
182    * Set width if
183    * 
184    * @param i
185    */
186
187   void setIdWidth(int i);
188
189   /**
190    * centre columnar annotation labels in displayed alignment annotation
191    */
192   boolean isCentreColumnLabels();
193
194   /**
195    * centre columnar annotation labels in displayed alignment annotation
196    */
197   void setCentreColumnLabels(boolean centreColumnLabels);
198
199   /**
200    * enable or disable the display of Database Cross References in the sequence
201    * ID tooltip
202    */
203   void setShowDBRefs(boolean showdbrefs);
204
205   /**
206    * 
207    * @return true if Database References are to be displayed on tooltips.
208    */
209   boolean isShowDBRefs();
210
211   /**
212    * 
213    * @return true if Non-positional features are to be displayed on tooltips.
214    */
215   boolean isShowNPFeats();
216
217   /**
218    * enable or disable the display of Non-Positional sequence features in the
219    * sequence ID tooltip
220    * 
221    * @param show
222    */
223   void setShowNPFeats(boolean shownpfeats);
224
225   /**
226    * Get flag to scale protein residues 3 times the width of cDNA bases (only
227    * applicable in SplitFrame views)
228    * 
229    * @return
230    */
231   boolean isScaleProteinAsCdna();
232
233   /**
234    * Set flag to scale protein residues 3 times the width of cDNA bases (only
235    * applicable in SplitFrame views)
236    * 
237    * @return
238    */
239   void setScaleProteinAsCdna(boolean b);
240 }