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 @SuppressWarnings("serial")
60 public class OverviewPanel extends JPanel
61 implements Runnable, ViewportListenerI
63 protected OverviewDimensions od;
65 private OverviewCanvas oviewCanvas;
67 private AlignViewportI av;
69 private AlignmentPanel ap;
71 protected JCheckBoxMenuItem displayToggle;
73 protected boolean showHidden = true;
75 protected boolean draggingBox = false;
77 protected ProgressPanel progressPanel;
80 * Creates a new OverviewPanel object.
83 * The alignment panel which is shown in the overview panel
85 public OverviewPanel(AlignmentPanel alPanel)
90 showHidden = Cache.getDefault(Preferences.SHOW_OV_HIDDEN_AT_START,
94 od = new OverviewDimensionsShowHidden(av.getRanges(),
95 (av.isShowAnnotation()
96 && av.getAlignmentConservationAnnotation() != null));
100 od = new OverviewDimensionsHideHidden(av.getRanges(),
101 (av.isShowAnnotation()
102 && av.getAlignmentConservationAnnotation() != null));
105 setLayout(new BorderLayout());
106 progressPanel = new ProgressPanel(OverviewRenderer.UPDATE,
107 MessageManager.getString("label.oview_calc"), getWidth());
108 this.add(progressPanel, BorderLayout.SOUTH);
109 oviewCanvas = new OverviewCanvas(od, av, progressPanel);
111 add(oviewCanvas, BorderLayout.CENTER);
113 av.getRanges().addPropertyChangeListener(this);
115 // without this the overview window does not size to fit the overview canvas
116 setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
118 addComponentListener(new ComponentAdapter()
121 public void componentResized(ComponentEvent evt)
123 // Resize is called on the initial display of the overview.
124 // This code adjusts sizes to account for the progress bar if it has not
125 // already been accounted for, which triggers another resize call for
126 // the correct sizing, at which point the overview image is updated.
127 // (This avoids a double recalculation of the image.)
128 if (getWidth() == od.getWidth() && getHeight() == od.getHeight()
129 + progressPanel.getHeight())
131 updateOverviewImage();
135 if ((getWidth() > 0) && (getHeight() > 0))
137 od.setWidth(getWidth());
138 od.setHeight(getHeight() - progressPanel.getHeight());
141 setPreferredSize(new Dimension(od.getWidth(),
142 od.getHeight() + progressPanel.getHeight()));
148 addMouseMotionListener(new MouseMotionAdapter()
151 public void mouseDragged(MouseEvent evt)
153 if (!SwingUtilities.isRightMouseButton(evt))
157 // set the mouse position as a fixed point in the box
158 // and drag relative to that position
159 od.adjustViewportFromMouse(evt.getX(), evt.getY(),
160 av.getAlignment().getHiddenSequences(),
161 av.getAlignment().getHiddenColumns());
165 od.updateViewportFromMouse(evt.getX(), evt.getY(),
166 av.getAlignment().getHiddenSequences(),
167 av.getAlignment().getHiddenColumns());
173 public void mouseMoved(MouseEvent evt)
175 if (od.isPositionInBox(evt.getX(), evt.getY()))
178 * using HAND_CURSOR rather than DRAG_CURSOR
179 * as the latter is not supported on Mac
181 getParent().setCursor(
182 Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
187 getParent().setCursor(
188 Cursor.getPredefinedCursor(Cursor.CROSSHAIR_CURSOR));
194 addMouseListener(new MouseAdapter()
197 public void mousePressed(MouseEvent evt)
200 if (Platform.isWinRightButton(evt)) {
204 if (SwingUtilities.isRightMouseButton(evt)) {
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());
233 public void mouseClicked(MouseEvent evt)
235 if (SwingUtilities.isRightMouseButton(evt))
242 public void mouseReleased(MouseEvent evt)
250 * Javascript does not call componentResized on initial display,
251 * so do the update here
255 updateOverviewImage();
260 * Displays the popup menu and acts on user input
262 protected void showPopupMenu(MouseEvent e)
264 JPopupMenu popup = new JPopupMenu();
265 ActionListener menuListener = new ActionListener()
268 public void actionPerformed(ActionEvent event)
270 // switch on/off the hidden columns view
271 toggleHiddenColumns();
272 displayToggle.setSelected(showHidden);
275 displayToggle = new JCheckBoxMenuItem(
276 MessageManager.getString("label.togglehidden"));
277 displayToggle.setEnabled(true);
278 displayToggle.setSelected(showHidden);
279 popup.add(displayToggle);
280 displayToggle.addActionListener(menuListener);
281 popup.show(this, e.getX(), e.getY());
285 * Toggle overview display between showing hidden columns and hiding hidden columns
287 protected void toggleHiddenColumns()
292 od = new OverviewDimensionsHideHidden(av.getRanges(),
293 (av.isShowAnnotation()
294 && av.getAlignmentConservationAnnotation() != null));
299 od = new OverviewDimensionsShowHidden(av.getRanges(),
300 (av.isShowAnnotation()
301 && av.getAlignmentConservationAnnotation() != null));
303 oviewCanvas.resetOviewDims(od);
304 updateOverviewImage();
309 * Updates the overview image when the related alignment panel is updated
311 public void updateOverviewImage()
313 if (oviewCanvas == null)
316 * panel has been disposed
321 if ((getWidth() > 0) && (getHeight() > 0))
323 od.setWidth(getWidth());
324 od.setHeight(getHeight() - progressPanel.getHeight());
327 setPreferredSize(new Dimension(od.getWidth(),
328 od.getHeight() + progressPanel.getHeight()));
330 if (oviewCanvas.restartDraw())
335 Thread thread = new Thread(this);
345 if (oviewCanvas != null)
347 oviewCanvas.draw(av.isShowSequenceFeatures(),
348 (av.isShowAnnotation()
349 && av.getAlignmentConservationAnnotation() != null),
350 ap.getSeqPanel().seqCanvas.getFeatureRenderer());
356 * Update the overview panel box when the associated alignment panel is
360 private void setBoxPositionOnly()
364 int oldX = od.getBoxX();
365 int oldY = od.getBoxY();
366 int oldWidth = od.getBoxWidth();
367 int oldHeight = od.getBoxHeight();
368 od.setBoxPosition(av.getAlignment().getHiddenSequences(),
369 av.getAlignment().getHiddenColumns());
370 repaint(oldX - 1, oldY - 1, oldWidth + 2, oldHeight + 2);
371 repaint(od.getBoxX(), od.getBoxY(), od.getBoxWidth(),
376 private void setBoxPosition()
380 od.setBoxPosition(av.getAlignment().getHiddenSequences(),
381 av.getAlignment().getHiddenColumns());
387 public void propertyChange(PropertyChangeEvent evt)
389 setBoxPositionOnly();
393 * Removes this object as a property change listener, and nulls references
395 protected void dispose()
401 av.getRanges().removePropertyChangeListener(this);
404 oviewCanvas.dispose();
407 * close the parent frame (which also removes it from the
408 * Desktop Windows menu)
410 ((JInternalFrame) SwingUtilities.getAncestorOfClass(
411 JInternalFrame.class, (this))).setClosed(true);
412 } catch (PropertyVetoException e)
417 progressPanel = null;