JAL-2403 redundant 'implements' removed
[jalview.git] / src / jalview / appletgui / ScalePanel.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.appletgui;
22
23 import jalview.datamodel.ColumnSelection;
24 import jalview.datamodel.SequenceGroup;
25 import jalview.renderer.ScaleRenderer;
26 import jalview.renderer.ScaleRenderer.ScaleMark;
27 import jalview.util.MessageManager;
28
29 import java.awt.Color;
30 import java.awt.FontMetrics;
31 import java.awt.Graphics;
32 import java.awt.MenuItem;
33 import java.awt.Panel;
34 import java.awt.PopupMenu;
35 import java.awt.event.ActionEvent;
36 import java.awt.event.ActionListener;
37 import java.awt.event.InputEvent;
38 import java.awt.event.MouseEvent;
39 import java.awt.event.MouseListener;
40 import java.awt.event.MouseMotionListener;
41 import java.util.List;
42
43 public class ScalePanel extends Panel implements MouseMotionListener,
44         MouseListener
45 {
46
47   protected int offy = 4;
48
49   public int width;
50
51   protected AlignViewport av;
52
53   AlignmentPanel ap;
54
55   boolean stretchingGroup = false;
56
57   int min; // used by mouseDragged to see if user
58
59   int max; // used by mouseDragged to see if user
60
61   boolean mouseDragging = false;
62
63   int[] reveal;
64
65   public ScalePanel(AlignViewport av, AlignmentPanel ap)
66   {
67     setLayout(null);
68     this.av = av;
69     this.ap = ap;
70
71     addMouseListener(this);
72     addMouseMotionListener(this);
73
74   }
75
76   @Override
77   public void mousePressed(MouseEvent evt)
78   {
79     int x = (evt.getX() / av.getCharWidth()) + av.getStartRes();
80     final int res;
81
82     if (av.hasHiddenColumns())
83     {
84       res = av.getColumnSelection().adjustForHiddenColumns(x);
85     }
86     else
87     {
88       res = x;
89     }
90
91     min = res;
92     max = res;
93     if ((evt.getModifiers() & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
94     {
95       rightMouseButtonPressed(evt, res);
96     }
97     else
98     {
99       leftMouseButtonPressed(evt, res);
100     }
101   }
102
103   /**
104    * Handles left mouse button pressed (selection / clear selections)
105    * 
106    * @param evt
107    * @param res
108    */
109   protected void leftMouseButtonPressed(MouseEvent evt, final int res)
110   {
111     if (!evt.isControlDown() && !evt.isShiftDown())
112     {
113       av.getColumnSelection().clear();
114     }
115
116     av.getColumnSelection().addElement(res);
117     SequenceGroup sg = new SequenceGroup();
118     for (int i = 0; i < av.getAlignment().getSequences().size(); i++)
119     {
120       sg.addSequence(av.getAlignment().getSequenceAt(i), false);
121     }
122
123     sg.setStartRes(res);
124     sg.setEndRes(res);
125     av.setSelectionGroup(sg);
126
127     if (evt.isShiftDown())
128     {
129       int min = Math.min(av.getColumnSelection().getMin(), res);
130       int max = Math.max(av.getColumnSelection().getMax(), res);
131       for (int i = min; i < max; i++)
132       {
133         av.getColumnSelection().addElement(i);
134       }
135       sg.setStartRes(min);
136       sg.setEndRes(max);
137     }
138     ap.paintAlignment(true);
139     av.sendSelection();
140   }
141
142   /**
143    * Handles right mouse button press. If pressed in a selected column, opens
144    * context menu for 'Hide Columns'. If pressed on a hidden columns marker,
145    * opens context menu for 'Reveal / Reveal All'. Else does nothing.
146    * 
147    * @param evt
148    * @param res
149    */
150   protected void rightMouseButtonPressed(MouseEvent evt, final int res)
151   {
152     PopupMenu pop = new PopupMenu();
153     if (reveal != null)
154     {
155       MenuItem item = new MenuItem(MessageManager.getString("label.reveal"));
156       item.addActionListener(new ActionListener()
157       {
158         @Override
159         public void actionPerformed(ActionEvent e)
160         {
161           av.showColumn(reveal[0]);
162           reveal = null;
163           ap.paintAlignment(true);
164           if (ap.overviewPanel != null)
165           {
166             ap.overviewPanel.updateOverviewImage();
167           }
168           av.sendSelection();
169         }
170       });
171       pop.add(item);
172
173       if (av.getColumnSelection().hasManyHiddenColumns())
174       {
175         item = new MenuItem(MessageManager.getString("action.reveal_all"));
176         item.addActionListener(new ActionListener()
177         {
178           @Override
179           public void actionPerformed(ActionEvent e)
180           {
181             av.showAllHiddenColumns();
182             reveal = null;
183             ap.paintAlignment(true);
184             if (ap.overviewPanel != null)
185             {
186               ap.overviewPanel.updateOverviewImage();
187             }
188             av.sendSelection();
189           }
190         });
191         pop.add(item);
192       }
193       this.add(pop);
194       pop.show(this, evt.getX(), evt.getY());
195     }
196     else if (av.getColumnSelection().contains(res))
197     {
198       MenuItem item = new MenuItem(
199               MessageManager.getString("label.hide_columns"));
200       item.addActionListener(new ActionListener()
201       {
202         @Override
203         public void actionPerformed(ActionEvent e)
204         {
205           av.hideColumns(res, res);
206           if (av.getSelectionGroup() != null
207                   && av.getSelectionGroup().getSize() == av.getAlignment()
208                           .getHeight())
209           {
210             av.setSelectionGroup(null);
211           }
212
213           ap.paintAlignment(true);
214           if (ap.overviewPanel != null)
215           {
216             ap.overviewPanel.updateOverviewImage();
217           }
218           av.sendSelection();
219         }
220       });
221       pop.add(item);
222       this.add(pop);
223       pop.show(this, evt.getX(), evt.getY());
224     }
225   }
226
227   @Override
228   public void mouseReleased(MouseEvent evt)
229   {
230     mouseDragging = false;
231
232     int res = (evt.getX() / av.getCharWidth()) + av.getStartRes();
233
234     if (res > av.getAlignment().getWidth())
235     {
236       res = av.getAlignment().getWidth() - 1;
237     }
238
239     if (av.hasHiddenColumns())
240     {
241       res = av.getColumnSelection().adjustForHiddenColumns(res);
242     }
243
244     if (!stretchingGroup)
245     {
246       ap.paintAlignment(false);
247
248       return;
249     }
250
251     SequenceGroup sg = av.getSelectionGroup();
252
253     if (res > sg.getStartRes())
254     {
255       sg.setEndRes(res);
256     }
257     else if (res < sg.getStartRes())
258     {
259       sg.setStartRes(res);
260     }
261
262     stretchingGroup = false;
263     ap.paintAlignment(false);
264     av.sendSelection();
265   }
266
267   /**
268    * Action on dragging the mouse in the scale panel is to expand or shrink the
269    * selection group range (including any hidden columns that it spans)
270    * 
271    * @param evt
272    */
273   @Override
274   public void mouseDragged(MouseEvent evt)
275   {
276     mouseDragging = true;
277     ColumnSelection cs = av.getColumnSelection();
278
279     int res = (evt.getX() / av.getCharWidth()) + av.getStartRes();
280     res = Math.max(0, res);
281     res = cs.adjustForHiddenColumns(res);
282     res = Math.min(res, av.getAlignment().getWidth() - 1);
283     min = Math.min(res, min);
284     max = Math.max(res, max);
285
286     SequenceGroup sg = av.getSelectionGroup();
287     if (sg != null)
288     {
289       stretchingGroup = true;
290       cs.stretchGroup(res, sg, min, max);
291       ap.paintAlignment(false);
292     }
293   }
294
295   @Override
296   public void mouseEntered(MouseEvent evt)
297   {
298     if (mouseDragging)
299     {
300       ap.seqPanel.scrollCanvas(null);
301     }
302   }
303
304   @Override
305   public void mouseExited(MouseEvent evt)
306   {
307     if (mouseDragging)
308     {
309       ap.seqPanel.scrollCanvas(evt);
310     }
311   }
312
313   @Override
314   public void mouseClicked(MouseEvent evt)
315   {
316
317   }
318
319   @Override
320   public void mouseMoved(MouseEvent evt)
321   {
322     if (!av.hasHiddenColumns())
323     {
324       return;
325     }
326
327     int res = (evt.getX() / av.getCharWidth()) + av.getStartRes();
328
329     res = av.getColumnSelection().adjustForHiddenColumns(res);
330
331     reveal = null;
332     for (int[] region : av.getColumnSelection().getHiddenColumns())
333     {
334       if (res + 1 == region[0] || res - 1 == region[1])
335       {
336         reveal = region;
337         break;
338       }
339     }
340
341     repaint();
342   }
343
344   @Override
345   public void update(Graphics g)
346   {
347     paint(g);
348   }
349
350   @Override
351   public void paint(Graphics g)
352   {
353     drawScale(g, av.getStartRes(), av.getEndRes(), getSize().width,
354             getSize().height);
355   }
356
357   // scalewidth will normally be screenwidth,
358   public void drawScale(Graphics gg, int startx, int endx, int width,
359           int height)
360   {
361     gg.setFont(av.getFont());
362     // Fill in the background
363     gg.setColor(Color.white);
364     gg.fillRect(0, 0, width, height);
365     gg.setColor(Color.black);
366
367     // Fill the selected columns
368     ColumnSelection cs = av.getColumnSelection();
369     int avCharWidth = av.getCharWidth();
370     int avcharHeight = av.getCharHeight();
371     if (cs != null)
372     {
373       gg.setColor(new Color(220, 0, 0));
374       boolean hasHiddenColumns = cs.hasHiddenColumns();
375       for (int sel : cs.getSelected())
376       {
377         // TODO: JAL-2001 - provide a fast method to list visible selected in a
378         // given range
379         if (hasHiddenColumns)
380         {
381           if (cs.isVisible(sel))
382           {
383             sel = cs.findColumnPosition(sel);
384           }
385           else
386           {
387             continue;
388           }
389         }
390
391         if ((sel >= startx) && (sel <= endx))
392         {
393           gg.fillRect((sel - startx) * avCharWidth, 0, avCharWidth,
394                   getSize().height);
395         }
396       }
397     }
398
399     // Draw the scale numbers
400     gg.setColor(Color.black);
401
402     int maxX = 0;
403     List<ScaleMark> marks = new ScaleRenderer().calculateMarks(av, startx,
404             endx);
405
406     FontMetrics fm = gg.getFontMetrics(av.getFont());
407     int y = avcharHeight;
408     int yOf = fm.getDescent();
409     y -= yOf;
410     for (ScaleMark mark : marks)
411     {
412       boolean major = mark.major;
413       int mpos = mark.column; // (i - startx - 1)
414       String mstring = mark.text;
415       if (mstring != null)
416       {
417         if (mpos * avCharWidth > maxX)
418         {
419           gg.drawString(mstring, mpos * avCharWidth, y);
420           maxX = (mpos + 2) * avCharWidth + fm.stringWidth(mstring);
421         }
422       }
423       if (major)
424       {
425         gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + 2,
426                 (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
427       }
428       else
429       {
430         gg.drawLine((mpos * avCharWidth) + (avCharWidth / 2), y + yOf,
431                 (mpos * avCharWidth) + (avCharWidth / 2), y + (yOf * 2));
432       }
433     }
434
435     if (av.hasHiddenColumns())
436     {
437       gg.setColor(Color.blue);
438       int res;
439       if (av.getShowHiddenMarkers())
440       {
441         int widthx = 1 + endx - startx;
442         for (int i = 0; i < cs.getHiddenColumns().size(); i++)
443         {
444
445           res = cs.findHiddenRegionPosition(i) - startx;
446
447           if (res < 0 || res > widthx)
448           {
449             continue;
450           }
451
452           gg.fillPolygon(new int[] {
453               -1 + res * avCharWidth - avcharHeight / 4,
454               -1 + res * avCharWidth + avcharHeight / 4,
455               -1 + res * avCharWidth }, new int[] { y, y, y + 2 * yOf }, 3);
456         }
457       }
458     }
459   }
460
461 }