JAL-1432 updated copyright notices
[jalview.git] / src / jalview / appletgui / ScalePanel.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
3  * Copyright (C) 2014 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 of the License, or (at your option) any later version.
10  *  
11  * Jalview is distributed in the hope that it will be useful, but 
12  * WITHOUT ANY WARRANTY; without even the implied warranty 
13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
14  * PURPOSE.  See the GNU General Public License for more details.
15  * 
16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
17  * The Jalview Authors are detailed in the 'AUTHORS' file.
18  */
19 package jalview.appletgui;
20
21 import java.awt.*;
22 import java.awt.event.*;
23
24 import jalview.datamodel.*;
25
26 public class ScalePanel extends Panel implements MouseMotionListener,
27         MouseListener
28 {
29
30   protected int offy = 4;
31
32   public int width;
33
34   protected AlignViewport av;
35
36   AlignmentPanel ap;
37
38   boolean stretchingGroup = false;
39
40   int min; // used by mouseDragged to see if user
41
42   int max; // used by mouseDragged to see if user
43
44   boolean mouseDragging = false;
45
46   int[] reveal;
47
48   public ScalePanel(AlignViewport av, AlignmentPanel ap)
49   {
50     setLayout(null);
51     this.av = av;
52     this.ap = ap;
53
54     addMouseListener(this);
55     addMouseMotionListener(this);
56
57   }
58
59   public void mousePressed(MouseEvent evt)
60   {
61     int x = (evt.getX() / av.getCharWidth()) + av.getStartRes();
62     final int res;
63
64     if (av.hasHiddenColumns())
65     {
66       res = av.getColumnSelection().adjustForHiddenColumns(x);
67     }
68     else
69     {
70       res = x;
71     }
72
73     min = res;
74     max = res;
75     if ((evt.getModifiers() & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
76     {
77       PopupMenu pop = new PopupMenu();
78       if (reveal != null)
79       {
80         MenuItem item = new MenuItem("Reveal");
81         item.addActionListener(new ActionListener()
82         {
83           public void actionPerformed(ActionEvent e)
84           {
85             av.showColumn(reveal[0]);
86             reveal = null;
87             ap.paintAlignment(true);
88             if (ap.overviewPanel != null)
89             {
90               ap.overviewPanel.updateOverviewImage();
91             }
92           }
93         });
94         pop.add(item);
95
96         if (av.getColumnSelection().getHiddenColumns().size() > 1)
97         {
98           item = new MenuItem("Reveal All");
99           item.addActionListener(new ActionListener()
100           {
101             public void actionPerformed(ActionEvent e)
102             {
103               av.showAllHiddenColumns();
104               reveal = null;
105               ap.paintAlignment(true);
106               if (ap.overviewPanel != null)
107               {
108                 ap.overviewPanel.updateOverviewImage();
109               }
110             }
111           });
112           pop.add(item);
113         }
114         this.add(pop);
115         pop.show(this, evt.getX(), evt.getY());
116       }
117       else if (av.getColumnSelection().contains(res))
118       {
119         MenuItem item = new MenuItem("Hide Columns");
120         item.addActionListener(new ActionListener()
121         {
122           public void actionPerformed(ActionEvent e)
123           {
124             av.hideColumns(res, res);
125             if (av.getSelectionGroup() != null
126                     && av.getSelectionGroup().getSize() == av
127                             .getAlignment().getHeight())
128             {
129               av.setSelectionGroup(null);
130             }
131
132             ap.paintAlignment(true);
133             if (ap.overviewPanel != null)
134             {
135               ap.overviewPanel.updateOverviewImage();
136             }
137           }
138         });
139         pop.add(item);
140         this.add(pop);
141         pop.show(this, evt.getX(), evt.getY());
142       }
143     }
144     else
145     // LEFT MOUSE TO SELECT
146     {
147       if (!evt.isControlDown() && !evt.isShiftDown())
148       {
149         av.getColumnSelection().clear();
150       }
151
152       av.getColumnSelection().addElement(res);
153       SequenceGroup sg = new SequenceGroup();
154       for (int i = 0; i < av.getAlignment().getSequences().size(); i++)
155       {
156         sg.addSequence(av.getAlignment().getSequenceAt(i), false);
157       }
158
159       sg.setStartRes(res);
160       sg.setEndRes(res);
161       av.setSelectionGroup(sg);
162
163       if (evt.isShiftDown())
164       {
165         int min = Math.min(av.getColumnSelection().getMin(), res);
166         int max = Math.max(av.getColumnSelection().getMax(), res);
167         for (int i = min; i < max; i++)
168         {
169           av.getColumnSelection().addElement(i);
170         }
171         sg.setStartRes(min);
172         sg.setEndRes(max);
173       }
174     }
175
176     ap.paintAlignment(true);
177     av.sendSelection();
178   }
179
180   public void mouseReleased(MouseEvent evt)
181   {
182     mouseDragging = false;
183
184     int res = (evt.getX() / av.getCharWidth()) + av.getStartRes();
185
186     if (res > av.getAlignment().getWidth())
187     {
188       res = av.getAlignment().getWidth() - 1;
189     }
190
191     if (av.hasHiddenColumns())
192     {
193       res = av.getColumnSelection().adjustForHiddenColumns(res);
194     }
195
196     if (!stretchingGroup)
197     {
198       ap.paintAlignment(false);
199
200       return;
201     }
202
203     SequenceGroup sg = av.getSelectionGroup();
204
205     if (res > sg.getStartRes())
206     {
207       sg.setEndRes(res);
208     }
209     else if (res < sg.getStartRes())
210     {
211       sg.setStartRes(res);
212     }
213
214     stretchingGroup = false;
215     ap.paintAlignment(false);
216     av.sendSelection();
217   }
218
219   public void mouseDragged(MouseEvent evt)
220   {
221     mouseDragging = true;
222
223     int res = (evt.getX() / av.getCharWidth()) + av.getStartRes();
224     if (res < 0)
225     {
226       res = 0;
227     }
228
229     if (av.hasHiddenColumns())
230     {
231       res = av.getColumnSelection().adjustForHiddenColumns(res);
232     }
233
234     if (res > av.getAlignment().getWidth())
235     {
236       res = av.getAlignment().getWidth() - 1;
237     }
238
239     if (res < min)
240     {
241       min = res;
242     }
243
244     if (res > max)
245     {
246       max = res;
247     }
248
249     SequenceGroup sg = av.getSelectionGroup();
250
251     if (sg != null)
252     {
253       stretchingGroup = true;
254
255       if (!av.getColumnSelection().contains(res))
256       {
257         av.getColumnSelection().addElement(res);
258       }
259
260       if (res > sg.getStartRes())
261       {
262         sg.setEndRes(res);
263       }
264       if (res < sg.getStartRes())
265       {
266         sg.setStartRes(res);
267       }
268
269       int col;
270       for (int i = min; i <= max; i++)
271       {
272         col = av.getColumnSelection().adjustForHiddenColumns(i);
273
274         if ((col < sg.getStartRes()) || (col > sg.getEndRes()))
275         {
276           av.getColumnSelection().removeElement(col);
277         }
278         else
279         {
280           av.getColumnSelection().addElement(col);
281         }
282       }
283
284       ap.paintAlignment(false);
285     }
286   }
287
288   public void mouseEntered(MouseEvent evt)
289   {
290     if (mouseDragging)
291     {
292       ap.seqPanel.scrollCanvas(null);
293     }
294   }
295
296   public void mouseExited(MouseEvent evt)
297   {
298     if (mouseDragging)
299     {
300       ap.seqPanel.scrollCanvas(evt);
301     }
302   }
303
304   public void mouseClicked(MouseEvent evt)
305   {
306
307   }
308
309   public void mouseMoved(MouseEvent evt)
310   {
311     if (!av.hasHiddenColumns())
312     {
313       return;
314     }
315
316     int res = (evt.getX() / av.getCharWidth()) + av.getStartRes();
317
318     res = av.getColumnSelection().adjustForHiddenColumns(res);
319
320     reveal = null;
321     for (int i = 0; i < av.getColumnSelection().getHiddenColumns().size(); i++)
322     {
323       int[] region = (int[]) av.getColumnSelection().getHiddenColumns()
324               .elementAt(i);
325       if (res + 1 == region[0] || res - 1 == region[1])
326       {
327         reveal = region;
328         break;
329       }
330     }
331
332     repaint();
333   }
334
335   public void update(Graphics g)
336   {
337     paint(g);
338   }
339
340   public void paint(Graphics g)
341   {
342     drawScale(g, av.getStartRes(), av.getEndRes(), getSize().width,
343             getSize().height);
344   }
345
346   // scalewidth will normally be screenwidth,
347   public void drawScale(Graphics gg, int startx, int endx, int width,
348           int height)
349   {
350     gg.setFont(av.getFont());
351
352     // Fill in the background
353     gg.setColor(Color.white);
354     gg.fillRect(0, 0, width, height);
355     gg.setColor(Color.black);
356
357     // Fill the selected columns
358     ColumnSelection cs = av.getColumnSelection();
359     gg.setColor(new Color(220, 0, 0));
360
361     for (int i = 0; i < cs.size(); i++)
362     {
363       int sel = cs.columnAt(i);
364       if (av.hasHiddenColumns())
365       {
366         sel = av.getColumnSelection().findColumnPosition(sel);
367       }
368
369       if ((sel >= startx) && (sel <= endx))
370       {
371         gg.fillRect((sel - startx) * av.charWidth, 0, av.charWidth,
372                 getSize().height);
373       }
374     }
375
376     // Draw the scale numbers
377     gg.setColor(Color.black);
378
379     int scalestartx = (startx / 10) * 10;
380
381     FontMetrics fm = gg.getFontMetrics(av.getFont());
382     int y = av.charHeight - fm.getDescent();
383
384     if ((scalestartx % 10) == 0)
385     {
386       scalestartx += 5;
387     }
388
389     String string;
390     int maxX = 0;
391
392     for (int i = scalestartx; i < endx; i += 5)
393     {
394       if ((i % 10) == 0)
395       {
396         string = String.valueOf(av.getColumnSelection()
397                 .adjustForHiddenColumns(i));
398         if ((i - startx - 1) * av.charWidth > maxX)
399         {
400           gg.drawString(string, (i - startx - 1) * av.charWidth, y);
401           maxX = (i - startx + 1) * av.charWidth + fm.stringWidth(string);
402         }
403
404         gg.drawLine(
405                 (int) (((i - startx - 1) * av.charWidth) + (av.charWidth / 2)),
406                 y + 2,
407                 (int) (((i - startx - 1) * av.charWidth) + (av.charWidth / 2)),
408                 y + (fm.getDescent() * 2));
409
410       }
411       else
412       {
413         gg.drawLine(
414                 (int) (((i - startx - 1) * av.charWidth) + (av.charWidth / 2)),
415                 y + fm.getDescent(),
416                 (int) (((i - startx - 1) * av.charWidth) + (av.charWidth / 2)),
417                 y + (fm.getDescent() * 2));
418       }
419     }
420
421     if (av.hasHiddenColumns())
422     {
423       gg.setColor(Color.blue);
424       int res;
425       if (av.getShowHiddenMarkers())
426       {
427         for (int i = 0; i < av.getColumnSelection().getHiddenColumns()
428                 .size(); i++)
429         {
430
431           res = av.getColumnSelection().findHiddenRegionPosition(i)
432                   - startx;
433
434           if (res < 0 || res > endx - scalestartx)
435           {
436             continue;
437           }
438
439           gg.fillPolygon(new int[]
440           { res * av.charWidth - av.charHeight / 4,
441               res * av.charWidth + av.charHeight / 4, res * av.charWidth },
442                   new int[]
443                   { y - av.charHeight / 2, y - av.charHeight / 2, y + 8 },
444                   3);
445
446         }
447       }
448
449       if (reveal != null && reveal[0] > startx && reveal[0] < endx)
450       {
451         gg.drawString("Reveal Columns", reveal[0] * av.charWidth, 0);
452       }
453     }
454
455   }
456
457 }