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.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;
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;
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;
52 * Panel displaying an overview of the full alignment, with an interactive box
53 * representing the viewport onto the alignment.
58 public class OverviewPanel extends JPanel
59 implements Runnable, ViewportListenerI
61 private OverviewDimensions od;
63 private OverviewCanvas oviewCanvas;
65 private AlignViewport av;
67 private AlignmentPanel ap;
69 private JCheckBoxMenuItem displayToggle;
71 private boolean showHidden = true;
73 private boolean draggingBox = false;
75 private ProgressPanel progressPanel;
78 * Creates a new OverviewPanel object.
81 * The alignment panel which is shown in the overview panel
83 public OverviewPanel(AlignmentPanel alPanel)
88 showHidden = Cache.getDefault(Preferences.SHOW_OV_HIDDEN_AT_START,
92 od = new OverviewDimensionsShowHidden(av.getRanges(),
93 (av.isShowAnnotation()
94 && av.getAlignmentConservationAnnotation() != null));
98 od = new OverviewDimensionsHideHidden(av.getRanges(),
99 (av.isShowAnnotation()
100 && av.getAlignmentConservationAnnotation() != null));
103 setLayout(new BorderLayout());
104 progressPanel = new ProgressPanel(OverviewRenderer.UPDATE,
105 MessageManager.getString("label.oview_calc"), getWidth());
106 this.add(progressPanel, BorderLayout.SOUTH);
107 oviewCanvas = new OverviewCanvas(od, av, progressPanel);
109 add(oviewCanvas, BorderLayout.CENTER);
111 av.getRanges().addPropertyChangeListener(this);
113 // without this the overview window does not size to fit the overview canvas
114 setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
116 addComponentListener(new ComponentAdapter()
119 public void componentResized(ComponentEvent evt)
121 // Resize is called on the initial display of the overview.
122 // This code adjusts sizes to account for the progress bar if it has not
123 // already been accounted for, which triggers another resize call for
124 // the correct sizing, at which point the overview image is updated.
125 // (This avoids a double recalculation of the image.)
126 if (getWidth() == od.getWidth() && getHeight() == od.getHeight()
127 + progressPanel.getHeight())
129 updateOverviewImage();
133 if ((getWidth() > 0) && (getHeight() > 0))
135 od.setWidth(getWidth());
136 od.setHeight(getHeight() - progressPanel.getHeight());
139 setPreferredSize(new Dimension(od.getWidth(),
140 od.getHeight() + progressPanel.getHeight()));
146 addMouseMotionListener(new MouseMotionAdapter()
149 public void mouseDragged(MouseEvent evt)
151 if (!SwingUtilities.isRightMouseButton(evt))
155 // set the mouse position as a fixed point in the box
156 // and drag relative to that position
157 od.adjustViewportFromMouse(evt.getX(), evt.getY(),
158 av.getAlignment().getHiddenSequences(),
159 av.getAlignment().getHiddenColumns());
163 od.updateViewportFromMouse(evt.getX(), evt.getY(),
164 av.getAlignment().getHiddenSequences(),
165 av.getAlignment().getHiddenColumns());
171 public void mouseMoved(MouseEvent evt)
173 if (od.isPositionInBox(evt.getX(), evt.getY()))
176 * using HAND_CURSOR rather than DRAG_CURSOR
177 * as the latter is not supported on Mac
179 getParent().setCursor(
180 Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
185 getParent().setCursor(
186 Cursor.getPredefinedCursor(Cursor.CROSSHAIR_CURSOR));
192 addMouseListener(new MouseAdapter()
195 public void mousePressed(MouseEvent evt)
197 if (SwingUtilities.isRightMouseButton(evt))
199 if (!Platform.isAMac())
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()))
212 od.updateViewportFromMouse(evt.getX(), evt.getY(),
213 av.getAlignment().getHiddenSequences(),
214 av.getAlignment().getHiddenColumns());
215 getParent().setCursor(
216 Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
221 od.setDragPoint(evt.getX(), evt.getY(),
222 av.getAlignment().getHiddenSequences(),
223 av.getAlignment().getHiddenColumns());
229 public void mouseClicked(MouseEvent evt)
231 if (SwingUtilities.isRightMouseButton(evt))
240 * Displays the popup menu and acts on user input
242 private void showPopupMenu(MouseEvent e)
244 JPopupMenu popup = new JPopupMenu();
245 ActionListener menuListener = new ActionListener()
248 public void actionPerformed(ActionEvent event)
250 // switch on/off the hidden columns view
251 toggleHiddenColumns();
252 displayToggle.setSelected(showHidden);
255 displayToggle = new JCheckBoxMenuItem(
256 MessageManager.getString("label.togglehidden"));
257 displayToggle.setEnabled(true);
258 displayToggle.setSelected(showHidden);
259 popup.add(displayToggle);
260 displayToggle.addActionListener(menuListener);
261 popup.show(this, e.getX(), e.getY());
265 * Toggle overview display between showing hidden columns and hiding hidden columns
267 private void toggleHiddenColumns()
272 od = new OverviewDimensionsHideHidden(av.getRanges(),
273 (av.isShowAnnotation()
274 && av.getAlignmentConservationAnnotation() != null));
279 od = new OverviewDimensionsShowHidden(av.getRanges(),
280 (av.isShowAnnotation()
281 && av.getAlignmentConservationAnnotation() != null));
283 oviewCanvas.resetOviewDims(od);
284 updateOverviewImage();
289 * Updates the overview image when the related alignment panel is updated
291 public void updateOverviewImage()
293 if (oviewCanvas == null)
296 * panel has been disposed
301 if ((getWidth() > 0) && (getHeight() > 0))
303 od.setWidth(getWidth());
304 od.setHeight(getHeight() - progressPanel.getHeight());
307 setPreferredSize(new Dimension(od.getWidth(),
308 od.getHeight() + progressPanel.getHeight()));
310 if (oviewCanvas.restartDraw())
315 Thread thread = new Thread(this);
325 if (oviewCanvas != null)
327 oviewCanvas.draw(av.isShowSequenceFeatures(),
328 (av.isShowAnnotation()
329 && av.getAlignmentConservationAnnotation() != null),
330 ap.getSeqPanel().seqCanvas.getFeatureRenderer());
336 * Update the overview panel box when the associated alignment panel is
340 private void setBoxPositionOnly()
344 int oldX = od.getBoxX();
345 int oldY = od.getBoxY();
346 int oldWidth = od.getBoxWidth();
347 int oldHeight = od.getBoxHeight();
348 od.setBoxPosition(av.getAlignment().getHiddenSequences(),
349 av.getAlignment().getHiddenColumns());
350 repaint(oldX - 1, oldY - 1, oldWidth + 2, oldHeight + 2);
351 repaint(od.getBoxX(), od.getBoxY(), od.getBoxWidth(),
356 private void setBoxPosition()
360 od.setBoxPosition(av.getAlignment().getHiddenSequences(),
361 av.getAlignment().getHiddenColumns());
367 public void propertyChange(PropertyChangeEvent evt)
369 setBoxPositionOnly();
373 * Removes this object as a property change listener, and nulls references
375 protected void dispose()
381 av.getRanges().removePropertyChangeListener(this);
384 oviewCanvas.dispose();
387 * close the parent frame (which also removes it from the
388 * Desktop Windows menu)
390 ((JInternalFrame) SwingUtilities.getAncestorOfClass(
391 JInternalFrame.class, (this))).setClosed(true);
392 } catch (PropertyVetoException e)
397 progressPanel = null;