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 private Dimension dim;
79 private boolean showProgress = !Platform.isJS();
81 protected ProgressPanel progressPanel;
85 * Creates the appropriate type of OverviewDimensions, with the desired size
87 private void createOverviewDimensions()
89 boolean showAnnotation = (av.isShowAnnotation()
90 && av.getAlignmentConservationAnnotation() != null);
93 od = new OverviewDimensionsShowHidden(av.getRanges(), showAnnotation,
98 od = new OverviewDimensionsHideHidden(av.getRanges(), showAnnotation,
103 public OverviewPanel(AlignmentPanel alPanel, Dimension dim)
105 this.av = alPanel.av;
109 showHidden = Cache.getDefault(Preferences.SHOW_OV_HIDDEN_AT_START,
111 createOverviewDimensions();
112 setLayout(new BorderLayout());
113 progressPanel = new ProgressPanel(OverviewRenderer.UPDATE,
114 MessageManager.getString("label.oview_calc"), getWidth());
115 this.add(progressPanel, BorderLayout.SOUTH);
116 oviewCanvas = new OverviewCanvas(od, av, progressPanel);
118 add(oviewCanvas, BorderLayout.CENTER);
120 av.getRanges().addPropertyChangeListener(this);
122 // without this the overview window does not size to fit the overview canvas
123 setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
125 addComponentListener(new ComponentAdapter()
128 public void componentResized(ComponentEvent evt)
130 // Resize is called on the initial display of the overview.
131 // This code adjusts sizes to account for the progress bar if it has not
132 // already been accounted for, which triggers another resize call for
133 // the correct sizing, at which point the overview image is updated.
134 // (This avoids a double recalculation of the image.)
135 if (getWidth() == od.getWidth() && getHeight() == od.getHeight()
136 + progressPanel.getHeight())
138 updateOverviewImage();
142 if ((getWidth() > 0) && (getHeight() > 0))
144 od.setWidth(getWidth());
145 od.setHeight(getHeight() - progressPanel.getHeight());
148 setPreferredSize(new Dimension(od.getWidth(),
149 od.getHeight() + progressPanel.getHeight()));
155 addMouseMotionListener(new MouseMotionAdapter()
158 public void mouseDragged(MouseEvent evt)
160 if (!SwingUtilities.isRightMouseButton(evt))
164 // set the mouse position as a fixed point in the box
165 // and drag relative to that position
166 od.adjustViewportFromMouse(evt.getX(), evt.getY(),
167 av.getAlignment().getHiddenSequences(),
168 av.getAlignment().getHiddenColumns());
172 od.updateViewportFromMouse(evt.getX(), evt.getY(),
173 av.getAlignment().getHiddenSequences(),
174 av.getAlignment().getHiddenColumns());
180 public void mouseMoved(MouseEvent evt)
182 if (od.isPositionInBox(evt.getX(), evt.getY()))
185 * using HAND_CURSOR rather than DRAG_CURSOR
186 * as the latter is not supported on Mac
188 getParent().setCursor(
189 Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
194 getParent().setCursor(
195 Cursor.getPredefinedCursor(Cursor.CROSSHAIR_CURSOR));
201 addMouseListener(new MouseAdapter()
204 public void mousePressed(MouseEvent evt)
207 if (Platform.isWinRightButton(evt)) {
211 if (SwingUtilities.isRightMouseButton(evt)) {
214 // don't do anything if the mouse press is in the overview's box
215 // (wait to see if it's a drag instead)
216 // otherwise update the viewport
217 if (!od.isPositionInBox(evt.getX(), evt.getY()))
221 // display drag cursor at mouse position
222 setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
224 od.updateViewportFromMouse(evt.getX(), evt.getY(),
225 av.getAlignment().getHiddenSequences(),
226 av.getAlignment().getHiddenColumns());
227 getParent().setCursor(
228 Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
233 od.setDragPoint(evt.getX(), evt.getY(),
234 av.getAlignment().getHiddenSequences(),
235 av.getAlignment().getHiddenColumns());
240 public void mouseClicked(MouseEvent evt)
242 if (SwingUtilities.isRightMouseButton(evt))
249 public void mouseReleased(MouseEvent evt)
257 * Javascript does not call componentResized on initial display,
258 * so do the update here
262 updateOverviewImage();
267 * Displays the popup menu and acts on user input
269 protected void showPopupMenu(MouseEvent e)
271 JPopupMenu popup = new JPopupMenu();
272 ActionListener menuListener = new ActionListener()
275 public void actionPerformed(ActionEvent event)
277 // switch on/off the hidden columns view
278 toggleHiddenColumns();
279 displayToggle.setSelected(showHidden);
282 displayToggle = new JCheckBoxMenuItem(
283 MessageManager.getString("label.togglehidden"));
284 displayToggle.setEnabled(true);
285 displayToggle.setSelected(showHidden);
286 popup.add(displayToggle);
287 displayToggle.addActionListener(menuListener);
288 popup.show(this, e.getX(), e.getY());
292 * Toggle overview display between showing hidden columns and hiding hidden columns
294 protected void toggleHiddenColumns()
296 showHidden = !showHidden;
297 createOverviewDimensions();
298 oviewCanvas.resetOviewDims(od);
299 updateOverviewImage();
304 * Updates the overview image when the related alignment panel is updated
306 public void updateOverviewImage()
308 if (oviewCanvas == null)
311 * panel has been disposed
316 if ((getWidth() > 0) && (getHeight() > 0))
318 od.setWidth(getWidth());
319 od.setHeight(getHeight() - progressPanel.getHeight());
322 setPreferredSize(new Dimension(od.getWidth(),
323 od.getHeight() + progressPanel.getHeight()));
325 if (oviewCanvas.restartDraw())
330 Thread thread = new Thread(this);
340 if (oviewCanvas != null)
342 oviewCanvas.draw(av.isShowSequenceFeatures(),
343 (av.isShowAnnotation()
344 && av.getAlignmentConservationAnnotation() != null),
345 ap.getSeqPanel().seqCanvas.getFeatureRenderer());
351 * Update the overview panel box when the associated alignment panel is
355 private void setBoxPositionOnly()
359 int oldX = od.getBoxX();
360 int oldY = od.getBoxY();
361 int oldWidth = od.getBoxWidth();
362 int oldHeight = od.getBoxHeight();
363 od.setBoxPosition(av.getAlignment().getHiddenSequences(),
364 av.getAlignment().getHiddenColumns());
365 repaint(oldX - 1, oldY - 1, oldWidth + 2, oldHeight + 2);
366 repaint(od.getBoxX(), od.getBoxY(), od.getBoxWidth(),
371 private void setBoxPosition()
375 od.setBoxPosition(av.getAlignment().getHiddenSequences(),
376 av.getAlignment().getHiddenColumns());
382 public void propertyChange(PropertyChangeEvent evt)
384 setBoxPositionOnly();
388 * Removes this object as a property change listener, and nulls references
390 protected void dispose()
396 av.getRanges().removePropertyChangeListener(this);
399 oviewCanvas.dispose();
402 * close the parent frame (which also removes it from the
403 * Desktop Windows menu)
405 ((JInternalFrame) SwingUtilities.getAncestorOfClass(
406 JInternalFrame.class, (this))).setClosed(true);
407 } catch (PropertyVetoException e)
412 progressPanel = null;