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 java.awt.BorderLayout;
24 import java.awt.Cursor;
25 import java.awt.Dimension;
26 import java.awt.event.ActionEvent;
27 import java.awt.event.ActionListener;
28 import java.awt.event.ComponentAdapter;
29 import java.awt.event.ComponentEvent;
30 import java.awt.event.MouseAdapter;
31 import java.awt.event.MouseEvent;
32 import java.awt.event.MouseMotionAdapter;
33 import java.beans.PropertyChangeEvent;
34 import java.beans.PropertyVetoException;
36 import javax.swing.JCheckBoxMenuItem;
37 import javax.swing.JInternalFrame;
38 import javax.swing.JPanel;
39 import javax.swing.JPopupMenu;
40 import javax.swing.SwingUtilities;
42 import jalview.renderer.OverviewRenderer;
43 import jalview.util.MessageManager;
44 import jalview.util.Platform;
45 import jalview.viewmodel.OverviewDimensions;
46 import jalview.viewmodel.OverviewDimensionsHideHidden;
47 import jalview.viewmodel.OverviewDimensionsShowHidden;
48 import jalview.viewmodel.ViewportListenerI;
51 * Panel displaying an overview of the full alignment, with an interactive box
52 * representing the viewport onto the alignment.
57 @SuppressWarnings("serial")
58 public class OverviewPanel extends JPanel
59 implements Runnable, ViewportListenerI
61 protected OverviewDimensions od;
63 private OverviewCanvas oviewCanvas;
65 protected AlignViewport av;
67 private AlignmentPanel ap;
69 protected JCheckBoxMenuItem displayToggle;
71 protected boolean showHidden = true;
73 protected boolean draggingBox = false;
75 protected ProgressPanel progressPanel;
78 * Creates a new OverviewPanel object.
81 * The alignment panel which is shown in the overview panel
82 * @param isShowHidden TODO
84 public OverviewPanel(AlignmentPanel alPanel, boolean isShowHidden)
89 showHidden = isShowHidden;
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)
198 if (Platform.isWinRightButton(evt)) {
202 if (SwingUtilities.isRightMouseButton(evt)) {
205 // don't do anything if the mouse press is in the overview's box
206 // (wait to see if it's a drag instead)
207 // otherwise update the viewport
208 if (!od.isPositionInBox(evt.getX(), evt.getY()))
212 // display drag cursor at mouse position
213 setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
215 od.updateViewportFromMouse(evt.getX(), evt.getY(),
216 av.getAlignment().getHiddenSequences(),
217 av.getAlignment().getHiddenColumns());
218 getParent().setCursor(
219 Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
224 od.setDragPoint(evt.getX(), evt.getY(),
225 av.getAlignment().getHiddenSequences(),
226 av.getAlignment().getHiddenColumns());
231 public void mouseClicked(MouseEvent evt)
233 if (SwingUtilities.isRightMouseButton(evt))
240 public void mouseReleased(MouseEvent evt)
248 * Javascript does not call componentResized on initial display,
249 * so do the update here
253 updateOverviewImage();
258 * Displays the popup menu and acts on user input
260 protected void showPopupMenu(MouseEvent e)
262 JPopupMenu popup = new JPopupMenu();
263 ActionListener menuListener = new ActionListener()
266 public void actionPerformed(ActionEvent event)
268 // switch on/off the hidden columns view
269 toggleHiddenColumns();
270 displayToggle.setSelected(showHidden);
273 displayToggle = new JCheckBoxMenuItem(
274 MessageManager.getString("label.togglehidden"));
275 displayToggle.setEnabled(true);
276 displayToggle.setSelected(showHidden);
277 popup.add(displayToggle);
278 displayToggle.addActionListener(menuListener);
279 popup.show(this, e.getX(), e.getY());
283 * Toggle overview display between showing hidden columns and hiding hidden columns
285 protected void toggleHiddenColumns()
290 od = new OverviewDimensionsHideHidden(av.getRanges(),
291 (av.isShowAnnotation()
292 && av.getAlignmentConservationAnnotation() != null));
297 od = new OverviewDimensionsShowHidden(av.getRanges(),
298 (av.isShowAnnotation()
299 && av.getAlignmentConservationAnnotation() != null));
301 oviewCanvas.resetOviewDims(od);
302 updateOverviewImage();
307 * Updates the overview image when the related alignment panel is updated
309 public void updateOverviewImage()
311 if (oviewCanvas == null)
314 * panel has been disposed
319 if ((getWidth() > 0) && (getHeight() > 0))
321 od.setWidth(getWidth());
322 od.setHeight(getHeight() - progressPanel.getHeight());
325 setPreferredSize(new Dimension(od.getWidth(),
326 od.getHeight() + progressPanel.getHeight()));
328 if (oviewCanvas.restartDraw())
333 Thread thread = new Thread(this);
343 if (oviewCanvas != null)
345 oviewCanvas.draw(av.isShowSequenceFeatures(),
346 (av.isShowAnnotation()
347 && av.getAlignmentConservationAnnotation() != null),
348 ap.getSeqPanel().seqCanvas.getFeatureRenderer());
354 * Update the overview panel box when the associated alignment panel is
358 private void setBoxPositionOnly()
362 int oldX = od.getBoxX();
363 int oldY = od.getBoxY();
364 int oldWidth = od.getBoxWidth();
365 int oldHeight = od.getBoxHeight();
366 od.setBoxPosition(av.getAlignment().getHiddenSequences(),
367 av.getAlignment().getHiddenColumns());
368 repaint(oldX - 1, oldY - 1, oldWidth + 2, oldHeight + 2);
369 repaint(od.getBoxX(), od.getBoxY(), od.getBoxWidth(),
374 private void setBoxPosition()
378 od.setBoxPosition(av.getAlignment().getHiddenSequences(),
379 av.getAlignment().getHiddenColumns());
385 public void propertyChange(PropertyChangeEvent evt)
387 setBoxPositionOnly();
391 * Removes this object as a property change listener, and nulls references
393 protected void dispose()
399 av.getRanges().removePropertyChangeListener(this);
402 oviewCanvas.dispose();
405 * close the parent frame (which also removes it from the
406 * Desktop Windows menu)
408 ((JInternalFrame) SwingUtilities.getAncestorOfClass(
409 JInternalFrame.class, (this))).setClosed(true);
410 } catch (PropertyVetoException e)
415 progressPanel = null;
423 public boolean isShowHiddenRegions()
428 public OverviewCanvas getCanvas()