JAL-3851 remove old interface
[jalview.git] / src / jalview / gui / OverviewPanel.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.gui;
22
23 import jalview.bin.Cache;
24 import jalview.renderer.OverviewRenderer;
25 import jalview.util.MessageManager;
26 import jalview.util.Platform;
27 import jalview.viewmodel.OverviewDimensions;
28 import jalview.viewmodel.OverviewDimensionsHideHidden;
29 import jalview.viewmodel.OverviewDimensionsShowHidden;
30 import jalview.viewmodel.ViewportListenerI;
31
32 import java.awt.BorderLayout;
33 import java.awt.Cursor;
34 import java.awt.Dimension;
35 import java.awt.event.ActionEvent;
36 import java.awt.event.ActionListener;
37 import java.awt.event.ComponentAdapter;
38 import java.awt.event.ComponentEvent;
39 import java.awt.event.MouseAdapter;
40 import java.awt.event.MouseEvent;
41 import java.awt.event.MouseMotionAdapter;
42 import java.beans.PropertyChangeEvent;
43 import java.beans.PropertyVetoException;
44
45 import javax.swing.JCheckBoxMenuItem;
46 import javax.swing.JInternalFrame;
47 import javax.swing.JPanel;
48 import javax.swing.JPopupMenu;
49 import javax.swing.SwingUtilities;
50
51 /**
52  * Panel displaying an overview of the full alignment, with an interactive box
53  * representing the viewport onto the alignment.
54  * 
55  * @author $author$
56  * @version $Revision$
57  */
58 @SuppressWarnings("serial")
59 public class OverviewPanel extends JPanel
60         implements Runnable, ViewportListenerI
61 {
62   protected OverviewDimensions od;
63
64   private OverviewCanvas oviewCanvas;
65
66   protected AlignViewport av;
67
68   private AlignmentPanel ap;
69
70   protected JCheckBoxMenuItem displayToggle;
71
72   protected boolean showHidden = true;
73
74   protected boolean draggingBox = false;
75
76   protected ProgressPanel progressPanel;
77
78   /**
79    * Creates a new OverviewPanel object.
80    * 
81    * @param alPanel
82    *          The alignment panel which is shown in the overview panel
83    */
84   public OverviewPanel(AlignmentPanel alPanel)
85   {
86     this.av = alPanel.av;
87     this.ap = alPanel;
88
89     showHidden = Cache.getDefault(Preferences.SHOW_OV_HIDDEN_AT_START,
90             false);
91     if (showHidden)
92     {
93       od = new OverviewDimensionsShowHidden(av.getRanges(),
94             (av.isShowAnnotation()
95                     && av.getAlignmentConservationAnnotation() != null));
96     }
97     else
98     {
99       od = new OverviewDimensionsHideHidden(av.getRanges(),
100               (av.isShowAnnotation()
101                       && av.getAlignmentConservationAnnotation() != null));
102     }
103
104     setLayout(new BorderLayout());
105     progressPanel = new ProgressPanel(OverviewRenderer.UPDATE,
106             MessageManager.getString("label.oview_calc"), getWidth());
107     this.add(progressPanel, BorderLayout.SOUTH);
108     oviewCanvas = new OverviewCanvas(od, av, progressPanel);
109
110     add(oviewCanvas, BorderLayout.CENTER);
111
112     av.getRanges().addPropertyChangeListener(this);
113
114     // without this the overview window does not size to fit the overview canvas
115     setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
116     
117     addComponentListener(new ComponentAdapter()
118     {
119       @Override
120       public void componentResized(ComponentEvent evt)
121       {
122         // Resize is called on the initial display of the overview.
123         // This code adjusts sizes to account for the progress bar if it has not
124         // already been accounted for, which triggers another resize call for
125         // the correct sizing, at which point the overview image is updated.
126         // (This avoids a double recalculation of the image.)
127         if (getWidth() == od.getWidth() && getHeight() == od.getHeight()
128                 + progressPanel.getHeight())
129         {
130           updateOverviewImage();
131         }
132         else
133         {
134           if ((getWidth() > 0) && (getHeight() > 0))
135           {
136             od.setWidth(getWidth());
137             od.setHeight(getHeight() - progressPanel.getHeight());
138           }
139
140           setPreferredSize(new Dimension(od.getWidth(),
141                   od.getHeight() + progressPanel.getHeight()));
142         }
143       }
144
145     });
146
147     addMouseMotionListener(new MouseMotionAdapter()
148     {
149       @Override
150       public void mouseDragged(MouseEvent evt)
151       {
152         if (!SwingUtilities.isRightMouseButton(evt))
153         {
154           if (draggingBox)
155           {
156             // set the mouse position as a fixed point in the box
157             // and drag relative to that position
158             od.adjustViewportFromMouse(evt.getX(), evt.getY(),
159                     av.getAlignment().getHiddenSequences(),
160                     av.getAlignment().getHiddenColumns());
161           }
162           else
163           {
164             od.updateViewportFromMouse(evt.getX(), evt.getY(),
165                     av.getAlignment().getHiddenSequences(),
166                     av.getAlignment().getHiddenColumns());
167           }
168         }
169       }
170
171       @Override
172       public void mouseMoved(MouseEvent evt)
173       {
174         if (od.isPositionInBox(evt.getX(), evt.getY()))
175         {
176           /*
177            * using HAND_CURSOR rather than DRAG_CURSOR 
178            * as the latter is not supported on Mac
179            */
180           getParent().setCursor(
181                   Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
182         }
183         else
184         {
185           // reset cursor
186           getParent().setCursor(
187                   Cursor.getPredefinedCursor(Cursor.CROSSHAIR_CURSOR));
188         }
189       }
190
191     });
192
193     addMouseListener(new MouseAdapter()
194     {
195       @Override
196       public void mousePressed(MouseEvent evt)
197       {
198           
199         if (Platform.isWinRightButton(evt)) {
200                 showPopupMenu(evt);
201                 return;
202         }
203         if (SwingUtilities.isRightMouseButton(evt)) {
204                 return;
205         }
206           // don't do anything if the mouse press is in the overview's box
207           // (wait to see if it's a drag instead)
208           // otherwise update the viewport
209           if (!od.isPositionInBox(evt.getX(), evt.getY()))
210           {
211             draggingBox = false;
212
213             // display drag cursor at mouse position
214             setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
215
216             od.updateViewportFromMouse(evt.getX(), evt.getY(),
217                     av.getAlignment().getHiddenSequences(),
218                     av.getAlignment().getHiddenColumns());
219             getParent().setCursor(
220                     Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
221           }
222           else
223           {
224             draggingBox = true;
225             od.setDragPoint(evt.getX(), evt.getY(),
226                     av.getAlignment().getHiddenSequences(),
227                     av.getAlignment().getHiddenColumns());
228           }
229       }
230
231       @Override
232       public void mouseClicked(MouseEvent evt)
233       {
234         if (SwingUtilities.isRightMouseButton(evt))
235         {
236           showPopupMenu(evt);
237         }
238       }
239
240       @Override
241       public void mouseReleased(MouseEvent evt)
242       {
243         draggingBox = false;
244       }
245
246     });
247
248     /*
249      * Javascript does not call componentResized on initial display,
250      * so do the update here
251      */
252     if (Platform.isJS())
253     {
254       updateOverviewImage();
255     }
256   }
257
258   /*
259    * Displays the popup menu and acts on user input
260    */
261   protected void showPopupMenu(MouseEvent e)
262   {
263     JPopupMenu popup = new JPopupMenu();
264     ActionListener menuListener = new ActionListener()
265     {
266       @Override
267       public void actionPerformed(ActionEvent event)
268       {
269         // switch on/off the hidden columns view
270         toggleHiddenColumns();
271         displayToggle.setSelected(showHidden);
272       }
273     };
274     displayToggle = new JCheckBoxMenuItem(
275             MessageManager.getString("label.togglehidden"));
276     displayToggle.setEnabled(true);
277     displayToggle.setSelected(showHidden);
278     popup.add(displayToggle);
279     displayToggle.addActionListener(menuListener);
280     popup.show(this, e.getX(), e.getY());
281   }
282
283   /*
284    * Toggle overview display between showing hidden columns and hiding hidden columns
285    */
286   protected void toggleHiddenColumns()
287   {
288     if (showHidden)
289     {
290       showHidden = false;
291       od = new OverviewDimensionsHideHidden(av.getRanges(),
292               (av.isShowAnnotation()
293                       && av.getAlignmentConservationAnnotation() != null));
294     }
295     else
296     {
297       showHidden = true;
298       od = new OverviewDimensionsShowHidden(av.getRanges(),
299               (av.isShowAnnotation()
300                       && av.getAlignmentConservationAnnotation() != null));
301     }
302     oviewCanvas.resetOviewDims(od);
303     updateOverviewImage();
304     setBoxPosition();
305   }
306
307   /**
308    * Updates the overview image when the related alignment panel is updated
309    */
310   public void updateOverviewImage()
311   {
312     if (oviewCanvas == null)
313     {
314       /*
315        * panel has been disposed
316        */
317       return;
318     }
319
320     if ((getWidth() > 0) && (getHeight() > 0))
321     {
322       od.setWidth(getWidth());
323       od.setHeight(getHeight() - progressPanel.getHeight());
324     }
325     
326     setPreferredSize(new Dimension(od.getWidth(),
327             od.getHeight() + progressPanel.getHeight()));
328
329     if (oviewCanvas.restartDraw())
330     {
331       return;
332     }
333
334     Thread thread = new Thread(this);
335     thread.start();
336     repaint();
337
338     
339   }
340
341   @Override
342   public void run()
343   {
344     if (oviewCanvas != null)
345     {
346       oviewCanvas.draw(av.isShowSequenceFeatures(),
347               (av.isShowAnnotation()
348                       && av.getAlignmentConservationAnnotation() != null),
349               ap.getSeqPanel().seqCanvas.getFeatureRenderer());
350       setBoxPosition();
351     }
352   }
353
354   /**
355    * Update the overview panel box when the associated alignment panel is
356    * changed
357    * 
358    */
359   private void setBoxPositionOnly()
360   {
361     if (od != null)
362     {
363       int oldX = od.getBoxX();
364       int oldY = od.getBoxY();
365       int oldWidth = od.getBoxWidth();
366       int oldHeight = od.getBoxHeight();
367       od.setBoxPosition(av.getAlignment().getHiddenSequences(),
368               av.getAlignment().getHiddenColumns());
369       repaint(oldX - 1, oldY - 1, oldWidth + 2, oldHeight + 2);
370       repaint(od.getBoxX(), od.getBoxY(), od.getBoxWidth(),
371               od.getBoxHeight());
372     }
373   }
374
375   private void setBoxPosition()
376   {
377     if (od != null)
378     {
379       od.setBoxPosition(av.getAlignment().getHiddenSequences(),
380               av.getAlignment().getHiddenColumns());
381       repaint();
382     }
383   }
384
385   @Override
386   public void propertyChange(PropertyChangeEvent evt)
387   {
388     setBoxPositionOnly();
389   }
390
391   /**
392    * Removes this object as a property change listener, and nulls references
393    */
394   protected void dispose()
395   {
396     try
397     {
398       if (av != null)
399       {
400         av.getRanges().removePropertyChangeListener(this);
401       }
402
403       oviewCanvas.dispose();
404
405       /*
406        * close the parent frame (which also removes it from the
407        * Desktop Windows menu)
408        */
409       ((JInternalFrame) SwingUtilities.getAncestorOfClass(
410               JInternalFrame.class, (this))).setClosed(true);
411     } catch (PropertyVetoException e)
412     {
413       // ignore
414     } finally
415     {
416       progressPanel = null;
417       av = null;
418       oviewCanvas = null;
419       ap = null;
420       od = null;
421     }
422   }
423 }