2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
23 import jalview.api.AlignViewportI;
24 import jalview.bin.Cache;
25 import jalview.renderer.OverviewRenderer;
26 import jalview.util.MessageManager;
27 import jalview.util.Platform;
28 import jalview.viewmodel.OverviewDimensions;
29 import jalview.viewmodel.OverviewDimensionsHideHidden;
30 import jalview.viewmodel.OverviewDimensionsShowHidden;
31 import jalview.viewmodel.ViewportListenerI;
33 import java.awt.BorderLayout;
34 import java.awt.Cursor;
35 import java.awt.Dimension;
36 import java.awt.event.ActionEvent;
37 import java.awt.event.ActionListener;
38 import java.awt.event.ComponentAdapter;
39 import java.awt.event.ComponentEvent;
40 import java.awt.event.MouseAdapter;
41 import java.awt.event.MouseEvent;
42 import java.awt.event.MouseMotionAdapter;
43 import java.beans.PropertyChangeEvent;
44 import java.beans.PropertyVetoException;
46 import javax.swing.JCheckBoxMenuItem;
47 import javax.swing.JInternalFrame;
48 import javax.swing.JPanel;
49 import javax.swing.JPopupMenu;
50 import javax.swing.SwingUtilities;
53 * Panel displaying an overview of the full alignment, with an interactive box
54 * representing the viewport onto the alignment.
59 public class OverviewPanel extends JPanel
60 implements Runnable, ViewportListenerI
62 private OverviewDimensions od;
64 private OverviewCanvas oviewCanvas;
66 private AlignViewportI av;
68 private AlignmentPanel ap;
70 private JCheckBoxMenuItem displayToggle;
72 private boolean showHidden = true;
74 private boolean draggingBox = false;
76 private ProgressPanel progressPanel;
79 * Creates a new OverviewPanel object.
82 * The alignment panel which is shown in the overview panel
84 public OverviewPanel(AlignmentPanel alPanel)
89 showHidden = Cache.getDefault(Preferences.SHOW_OV_HIDDEN_AT_START,
93 od = new OverviewDimensionsShowHidden(av.getRanges(),
94 (av.isShowAnnotation()
95 && av.getAlignmentConservationAnnotation() != null));
99 od = new OverviewDimensionsHideHidden(av.getRanges(),
100 (av.isShowAnnotation()
101 && av.getAlignmentConservationAnnotation() != null));
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);
110 add(oviewCanvas, BorderLayout.CENTER);
112 av.getRanges().addPropertyChangeListener(this);
114 // without this the overview window does not size to fit the overview canvas
115 setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
117 addComponentListener(new ComponentAdapter()
120 public void componentResized(ComponentEvent evt)
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())
130 updateOverviewImage();
134 if ((getWidth() > 0) && (getHeight() > 0))
136 od.setWidth(getWidth());
137 od.setHeight(getHeight() - progressPanel.getHeight());
140 setPreferredSize(new Dimension(od.getWidth(),
141 od.getHeight() + progressPanel.getHeight()));
147 addMouseMotionListener(new MouseMotionAdapter()
150 public void mouseDragged(MouseEvent evt)
152 if (!SwingUtilities.isRightMouseButton(evt))
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());
164 od.updateViewportFromMouse(evt.getX(), evt.getY(),
165 av.getAlignment().getHiddenSequences(),
166 av.getAlignment().getHiddenColumns());
172 public void mouseMoved(MouseEvent evt)
174 if (od.isPositionInBox(evt.getX(), evt.getY()))
177 * using HAND_CURSOR rather than DRAG_CURSOR
178 * as the latter is not supported on Mac
180 getParent().setCursor(
181 Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
186 getParent().setCursor(
187 Cursor.getPredefinedCursor(Cursor.CROSSHAIR_CURSOR));
193 addMouseListener(new MouseAdapter()
196 public void mousePressed(MouseEvent evt)
198 if (SwingUtilities.isRightMouseButton(evt))
200 if (!Platform.isAMac())
207 // don't do anything if the mouse press is in the overview's box
208 // (wait to see if it's a drag instead)
209 // otherwise update the viewport
210 if (!od.isPositionInBox(evt.getX(), evt.getY()))
214 // display drag cursor at mouse position
215 setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
217 od.updateViewportFromMouse(evt.getX(), evt.getY(),
218 av.getAlignment().getHiddenSequences(),
219 av.getAlignment().getHiddenColumns());
220 getParent().setCursor(
221 Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
226 od.setDragPoint(evt.getX(), evt.getY(),
227 av.getAlignment().getHiddenSequences(),
228 av.getAlignment().getHiddenColumns());
234 public void mouseClicked(MouseEvent evt)
236 if (SwingUtilities.isRightMouseButton(evt))
243 public void mouseReleased(MouseEvent evt)
252 * Displays the popup menu and acts on user input
254 private void showPopupMenu(MouseEvent e)
256 JPopupMenu popup = new JPopupMenu();
257 ActionListener menuListener = new ActionListener()
260 public void actionPerformed(ActionEvent event)
262 // switch on/off the hidden columns view
263 toggleHiddenColumns();
264 displayToggle.setSelected(showHidden);
267 displayToggle = new JCheckBoxMenuItem(
268 MessageManager.getString("label.togglehidden"));
269 displayToggle.setEnabled(true);
270 displayToggle.setSelected(showHidden);
271 popup.add(displayToggle);
272 displayToggle.addActionListener(menuListener);
273 popup.show(this, e.getX(), e.getY());
277 * Toggle overview display between showing hidden columns and hiding hidden columns
279 private void toggleHiddenColumns()
284 od = new OverviewDimensionsHideHidden(av.getRanges(),
285 (av.isShowAnnotation()
286 && av.getAlignmentConservationAnnotation() != null));
291 od = new OverviewDimensionsShowHidden(av.getRanges(),
292 (av.isShowAnnotation()
293 && av.getAlignmentConservationAnnotation() != null));
295 oviewCanvas.resetOviewDims(od);
296 updateOverviewImage();
301 * Updates the overview image when the related alignment panel is updated
303 public void updateOverviewImage()
305 if (oviewCanvas == null)
308 * panel has been disposed
313 if ((getWidth() > 0) && (getHeight() > 0))
315 od.setWidth(getWidth());
316 od.setHeight(getHeight() - progressPanel.getHeight());
319 setPreferredSize(new Dimension(od.getWidth(),
320 od.getHeight() + progressPanel.getHeight()));
322 if (oviewCanvas.restartDraw())
327 Thread thread = new Thread(this);
337 if (oviewCanvas != null)
339 oviewCanvas.draw(av.isShowSequenceFeatures(),
340 (av.isShowAnnotation()
341 && av.getAlignmentConservationAnnotation() != null),
342 ap.getSeqPanel().seqCanvas.getFeatureRenderer());
348 * Update the overview panel box when the associated alignment panel is
352 private void setBoxPositionOnly()
356 int oldX = od.getBoxX();
357 int oldY = od.getBoxY();
358 int oldWidth = od.getBoxWidth();
359 int oldHeight = od.getBoxHeight();
360 od.setBoxPosition(av.getAlignment().getHiddenSequences(),
361 av.getAlignment().getHiddenColumns());
362 repaint(oldX - 1, oldY - 1, oldWidth + 2, oldHeight + 2);
363 repaint(od.getBoxX(), od.getBoxY(), od.getBoxWidth(),
368 private void setBoxPosition()
372 od.setBoxPosition(av.getAlignment().getHiddenSequences(),
373 av.getAlignment().getHiddenColumns());
379 public void propertyChange(PropertyChangeEvent evt)
381 setBoxPositionOnly();
385 * Removes this object as a property change listener, and nulls references
387 protected void dispose()
393 av.getRanges().removePropertyChangeListener(this);
396 oviewCanvas.dispose();
399 * close the parent frame (which also removes it from the
400 * Desktop Windows menu)
402 ((JInternalFrame) SwingUtilities.getAncestorOfClass(
403 JInternalFrame.class, (this))).setClosed(true);
404 } catch (PropertyVetoException e)
409 progressPanel = null;