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;
44 import javax.swing.JCheckBoxMenuItem;
45 import javax.swing.JPanel;
46 import javax.swing.JPopupMenu;
47 import javax.swing.SwingUtilities;
50 * Panel displaying an overview of the full alignment, with an interactive box
51 * representing the viewport onto the alignment.
56 public class OverviewPanel extends JPanel
57 implements Runnable, ViewportListenerI
59 private OverviewDimensions od;
61 private OverviewCanvas oviewCanvas;
63 private AlignViewport av;
65 private AlignmentPanel ap;
67 private JCheckBoxMenuItem displayToggle;
69 private boolean showHidden = true;
71 private boolean draggingBox = false;
73 private ProgressPanel progressPanel;
76 * Creates a new OverviewPanel object.
79 * The alignment panel which is shown in the overview panel
81 public OverviewPanel(AlignmentPanel alPanel)
86 showHidden = Cache.getDefault(Preferences.SHOW_OV_HIDDEN_AT_START,
90 od = new OverviewDimensionsShowHidden(av.getRanges(),
91 (av.isShowAnnotation()
92 && av.getAlignmentConservationAnnotation() != null));
96 od = new OverviewDimensionsHideHidden(av.getRanges(),
97 (av.isShowAnnotation()
98 && av.getAlignmentConservationAnnotation() != null));
101 setLayout(new BorderLayout());
102 progressPanel = new ProgressPanel(OverviewRenderer.UPDATE,
103 MessageManager.getString("label.oview_calc"), getWidth());
104 this.add(progressPanel, BorderLayout.SOUTH);
105 oviewCanvas = new OverviewCanvas(od, av, progressPanel);
107 add(oviewCanvas, BorderLayout.CENTER);
109 av.getRanges().addPropertyChangeListener(this);
111 // without this the overview window does not size to fit the overview canvas
112 setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
114 addComponentListener(new ComponentAdapter()
117 public void componentResized(ComponentEvent evt)
119 // Resize is called on the initial display of the overview.
120 // This code adjusts sizes to account for the progress bar if it has not
121 // already been accounted for, which triggers another resize call for
122 // the correct sizing, at which point the overview image is updated.
123 // (This avoids a double recalculation of the image.)
124 if (getWidth() == od.getWidth() && getHeight() == od.getHeight()
125 + progressPanel.getHeight())
127 updateOverviewImage();
131 if ((getWidth() > 0) && (getHeight() > 0))
133 od.setWidth(getWidth());
134 od.setHeight(getHeight() - progressPanel.getHeight());
137 setPreferredSize(new Dimension(od.getWidth(),
138 od.getHeight() + progressPanel.getHeight()));
144 addMouseMotionListener(new MouseMotionAdapter()
147 public void mouseDragged(MouseEvent evt)
149 if (!SwingUtilities.isRightMouseButton(evt))
153 // set the mouse position as a fixed point in the box
154 // and drag relative to that position
155 od.adjustViewportFromMouse(evt.getX(), evt.getY(),
156 av.getAlignment().getHiddenSequences(),
157 av.getAlignment().getHiddenColumns());
161 od.updateViewportFromMouse(evt.getX(), evt.getY(),
162 av.getAlignment().getHiddenSequences(),
163 av.getAlignment().getHiddenColumns());
169 public void mouseMoved(MouseEvent evt)
171 if (od.isPositionInBox(evt.getX(), evt.getY()))
173 // display drag cursor at mouse position
174 setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
179 setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
184 addMouseListener(new MouseAdapter()
187 public void mousePressed(MouseEvent evt)
189 if (SwingUtilities.isRightMouseButton(evt))
191 if (!Platform.isAMac())
198 // don't do anything if the mouse press is in the overview's box
199 // (wait to see if it's a drag instead)
200 // otherwise update the viewport
201 if (!od.isPositionInBox(evt.getX(), evt.getY()))
204 od.updateViewportFromMouse(evt.getX(), evt.getY(),
205 av.getAlignment().getHiddenSequences(),
206 av.getAlignment().getHiddenColumns());
211 od.setDragPoint(evt.getX(), evt.getY(),
212 av.getAlignment().getHiddenSequences(),
213 av.getAlignment().getHiddenColumns());
219 public void mouseClicked(MouseEvent evt)
221 if (SwingUtilities.isRightMouseButton(evt))
230 * Displays the popup menu and acts on user input
232 private void showPopupMenu(MouseEvent e)
234 JPopupMenu popup = new JPopupMenu();
235 ActionListener menuListener = new ActionListener()
238 public void actionPerformed(ActionEvent event)
240 // switch on/off the hidden columns view
241 toggleHiddenColumns();
242 displayToggle.setSelected(showHidden);
245 displayToggle = new JCheckBoxMenuItem(
246 MessageManager.getString("label.togglehidden"));
247 displayToggle.setEnabled(true);
248 displayToggle.setSelected(showHidden);
249 popup.add(displayToggle);
250 displayToggle.addActionListener(menuListener);
251 popup.show(this, e.getX(), e.getY());
255 * Toggle overview display between showing hidden columns and hiding hidden columns
257 private void toggleHiddenColumns()
262 od = new OverviewDimensionsHideHidden(av.getRanges(),
263 (av.isShowAnnotation()
264 && av.getAlignmentConservationAnnotation() != null));
269 od = new OverviewDimensionsShowHidden(av.getRanges(),
270 (av.isShowAnnotation()
271 && av.getAlignmentConservationAnnotation() != null));
273 oviewCanvas.resetOviewDims(od);
274 updateOverviewImage();
279 * Updates the overview image when the related alignment panel is updated
281 public void updateOverviewImage()
283 if (oviewCanvas == null)
286 * panel has been disposed
291 if ((getWidth() > 0) && (getHeight() > 0))
293 od.setWidth(getWidth());
294 od.setHeight(getHeight() - progressPanel.getHeight());
297 setPreferredSize(new Dimension(od.getWidth(),
298 od.getHeight() + progressPanel.getHeight()));
300 if (oviewCanvas.restartDraw())
305 Thread thread = new Thread(this);
315 if (oviewCanvas != null)
317 oviewCanvas.draw(av.isShowSequenceFeatures(),
318 (av.isShowAnnotation()
319 && av.getAlignmentConservationAnnotation() != null),
320 ap.getSeqPanel().seqCanvas.getFeatureRenderer());
326 * Update the overview panel box when the associated alignment panel is
330 private void setBoxPosition()
334 od.setBoxPosition(av.getAlignment().getHiddenSequences(),
335 av.getAlignment().getHiddenColumns());
341 public void propertyChange(PropertyChangeEvent evt)
347 * Removes this object as a property change listener, and nulls references
349 protected void dispose()
353 av.getRanges().removePropertyChangeListener(this);
354 oviewCanvas.dispose();
357 progressPanel = null;