added help and documentation for annotation editing.
[jalview.git] / src / jalview / gui / IdCanvas.java
1 /*\r
2  * Jalview - A Sequence Alignment Editor and Viewer\r
3  * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
4  *\r
5  * This program is free software; you can redistribute it and/or\r
6  * modify it under the terms of the GNU General Public License\r
7  * as published by the Free Software Foundation; either version 2\r
8  * of the License, or (at your option) any later version.\r
9  *\r
10  * This program is distributed in the hope that it will be useful,\r
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
13  * GNU General Public License for more details.\r
14  *\r
15  * You should have received a copy of the GNU General Public License\r
16  * along with this program; if not, write to the Free Software\r
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
18  */\r
19 package jalview.gui;\r
20 \r
21 import jalview.analysis.*;\r
22 \r
23 import jalview.datamodel.*;\r
24 \r
25 import java.awt.*;\r
26 import java.awt.image.*;\r
27 \r
28 import javax.swing.*;\r
29 \r
30 \r
31 /**\r
32  * DOCUMENT ME!\r
33  *\r
34  * @author $author$\r
35  * @version $Revision$\r
36  */\r
37 public class IdCanvas extends JPanel\r
38 {\r
39     protected AlignViewport av;\r
40     protected boolean showScores = true;\r
41     protected int maxIdLength = -1;\r
42     protected String maxIdStr = null;\r
43     BufferedImage image;\r
44     Graphics2D gg;\r
45     int imgHeight = 0;\r
46     boolean fastPaint = false;\r
47     java.util.Vector searchResults;\r
48 \r
49     /**\r
50      * Creates a new IdCanvas object.\r
51      *\r
52      * @param av DOCUMENT ME!\r
53      */\r
54     public IdCanvas(AlignViewport av)\r
55     {\r
56         setLayout(new BorderLayout());\r
57         this.av = av;\r
58         PaintRefresher.Register(this, av.alignment);\r
59     }\r
60 \r
61     /**\r
62      * DOCUMENT ME!\r
63      *\r
64      * @param gg DOCUMENT ME!\r
65      * @param s DOCUMENT ME!\r
66      * @param i DOCUMENT ME!\r
67      * @param starty DOCUMENT ME!\r
68      * @param ypos DOCUMENT ME!\r
69      */\r
70     public void drawIdString(Graphics2D gg, SequenceI s, int i, int starty,\r
71         int ypos)\r
72     {\r
73         int charHeight = av.charHeight;\r
74 \r
75         if ((searchResults != null) && searchResults.contains(s))\r
76         {\r
77             gg.setColor(Color.black);\r
78             gg.fillRect(0, ((i - starty) * charHeight) + ypos, getWidth(),\r
79                 charHeight);\r
80             gg.setColor(Color.white);\r
81         }\r
82         else if ((av.getSelectionGroup() != null) &&\r
83                 av.getSelectionGroup().sequences.contains(s))\r
84         {\r
85             gg.setColor(Color.lightGray);\r
86             gg.fillRect(0, ((i - starty) * charHeight) + ypos, getWidth(),\r
87                 charHeight);\r
88             gg.setColor(Color.white);\r
89         }\r
90         else\r
91         {\r
92             gg.setColor(s.getColor());\r
93             gg.fillRect(0, ((i - starty) * charHeight) + ypos, getWidth(),\r
94                 charHeight);\r
95             gg.setColor(Color.black);\r
96         }\r
97 \r
98         String string = s.getName();\r
99 \r
100         if (av.getShowFullId())\r
101         {\r
102             string = s.getDisplayId();\r
103         }\r
104 \r
105         gg.drawString(string, 0,\r
106             (((i - starty + 1) * charHeight) + ypos) - (charHeight / 5));\r
107     }\r
108 \r
109     /**\r
110      * DOCUMENT ME!\r
111      *\r
112      * @param vertical DOCUMENT ME!\r
113      */\r
114     public void fastPaint(int vertical)\r
115     {\r
116         if (gg == null)\r
117         {\r
118             repaint();\r
119 \r
120             return;\r
121         }\r
122 \r
123         gg.copyArea(0, 0, getWidth(), imgHeight, 0, -vertical * av.charHeight);\r
124 \r
125         int ss = av.startSeq;\r
126         int es = av.endSeq;\r
127         int transY = 0;\r
128 \r
129         if (vertical > 0) // scroll down\r
130         {\r
131             ss = es - vertical;\r
132 \r
133             if (ss < av.startSeq)\r
134             { // ie scrolling too fast, more than a page at a time\r
135                 ss = av.startSeq;\r
136             }\r
137             else\r
138             {\r
139                 transY = imgHeight - (vertical * av.charHeight);\r
140             }\r
141         }\r
142         else if (vertical < 0)\r
143         {\r
144             es = ss - vertical;\r
145 \r
146             if (es > av.endSeq)\r
147             {\r
148                 es = av.endSeq;\r
149             }\r
150         }\r
151 \r
152         gg.translate(0, transY);\r
153 \r
154         drawIds(ss, es);\r
155 \r
156         gg.translate(0, -transY);\r
157 \r
158         fastPaint = true;\r
159         repaint();\r
160     }\r
161 \r
162     /**\r
163      * DOCUMENT ME!\r
164      *\r
165      * @param g DOCUMENT ME!\r
166      */\r
167     public void paintComponent(Graphics g)\r
168     {\r
169         g.setColor(Color.white);\r
170         g.fillRect(0, 0, getWidth(), getHeight());\r
171 \r
172         if (fastPaint)\r
173         {\r
174             fastPaint = false;\r
175             g.drawImage(image, 0, 0, this);\r
176 \r
177             return;\r
178         }\r
179 \r
180         imgHeight = getHeight();\r
181         imgHeight -= (imgHeight % av.charHeight);\r
182 \r
183         if (imgHeight < 1)\r
184         {\r
185             return;\r
186         }\r
187 \r
188         image = new BufferedImage(getWidth(), imgHeight,\r
189                 BufferedImage.TYPE_INT_RGB);\r
190         gg = (Graphics2D) image.getGraphics();\r
191 \r
192         //Fill in the background\r
193         gg.setColor(Color.white);\r
194         gg.fillRect(0, 0, getWidth(), imgHeight);\r
195         gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,\r
196             RenderingHints.VALUE_ANTIALIAS_ON);\r
197 \r
198         Font italic = new Font(av.getFont().getName(), Font.ITALIC,\r
199                 av.getFont().getSize());\r
200         gg.setFont(italic);\r
201 \r
202         drawIds(av.getStartSeq(), av.endSeq);\r
203 \r
204         g.drawImage(image, 0, 0, this);\r
205     }\r
206 \r
207     /**\r
208      * DOCUMENT ME!\r
209      *\r
210      * @param starty DOCUMENT ME!\r
211      * @param endy DOCUMENT ME!\r
212      */\r
213     void drawIds(int starty, int endy)\r
214     {\r
215         Color currentColor = Color.white;\r
216         Color currentTextColor = Color.black;\r
217 \r
218         if (av.getWrapAlignment())\r
219         {\r
220             int rowSize = av.getEndRes() - av.getStartRes();\r
221 \r
222             // Draw the rest of the panels\r
223             for (int ypos = 2 * av.charHeight, row = av.startRes;\r
224                     (ypos <= getHeight()) && (row < av.alignment.getWidth());\r
225                     ypos += av.chunkHeight, row += rowSize)\r
226             {\r
227                 for (int i = starty; i < av.alignment.getHeight(); i++)\r
228                 {\r
229                     SequenceI s = av.alignment.getSequenceAt(i);\r
230                     drawIdString(gg, s, i, 0, ypos);\r
231                 }\r
232             }\r
233         }\r
234         else\r
235         {\r
236             //Now draw the id strings\r
237             for (int i = starty; i < endy; i++)\r
238             {\r
239                 // Selected sequence colours\r
240                 if ((searchResults != null) &&\r
241                         searchResults.contains(av.alignment.getSequenceAt(i)))\r
242                 {\r
243                     gg.setColor(Color.black);\r
244                     currentColor = Color.black;\r
245                     currentTextColor = Color.white;\r
246                 }\r
247                 else if ((av.getSelectionGroup() != null) &&\r
248                         av.getSelectionGroup().sequences.contains(\r
249                             av.alignment.getSequenceAt(i)))\r
250                 {\r
251                     currentColor = Color.lightGray;\r
252                     currentTextColor = Color.black;\r
253                 }\r
254                 else\r
255                 {\r
256                     currentColor = av.alignment.getSequenceAt(i).getColor();\r
257                     currentTextColor = Color.black;\r
258                 }\r
259 \r
260                 gg.setColor(currentColor);\r
261 \r
262                 gg.fillRect(0, (i - starty) * av.charHeight, getWidth(),\r
263                     av.charHeight);\r
264 \r
265                 gg.setColor(currentTextColor);\r
266 \r
267                 String string = av.alignment.getSequenceAt(i).getName();\r
268 \r
269                 if (av.getShowFullId())\r
270                 {\r
271                     string = av.alignment.getSequenceAt(i).getDisplayId();\r
272                 }\r
273 \r
274                 gg.drawString(string, 0,\r
275                     (((i - starty) * av.charHeight) + av.charHeight) -\r
276                     (av.charHeight / 5));\r
277             }\r
278 \r
279             // add a border\r
280             gg.setColor(Color.white);\r
281             gg.fillRect(getWidth() - 4, 0, 4, getHeight());\r
282         }\r
283     }\r
284 \r
285     /**\r
286      * DOCUMENT ME!\r
287      *\r
288      * @param found DOCUMENT ME!\r
289      */\r
290     public void setHighlighted(java.util.Vector found)\r
291     {\r
292         searchResults = found;\r
293         repaint();\r
294     }\r
295 }\r