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.
21 package jalview.appletgui;
23 import jalview.util.MessageManager;
24 import jalview.util.Platform;
25 import jalview.viewmodel.OverviewDimensions;
26 import jalview.viewmodel.OverviewDimensionsHideHidden;
27 import jalview.viewmodel.OverviewDimensionsShowHidden;
28 import jalview.viewmodel.ViewportListenerI;
30 import java.awt.BorderLayout;
31 import java.awt.CheckboxMenuItem;
32 import java.awt.Cursor;
33 import java.awt.Dimension;
34 import java.awt.Panel;
35 import java.awt.PopupMenu;
36 import java.awt.event.ComponentAdapter;
37 import java.awt.event.ComponentEvent;
38 import java.awt.event.InputEvent;
39 import java.awt.event.ItemEvent;
40 import java.awt.event.ItemListener;
41 import java.awt.event.MouseEvent;
42 import java.awt.event.MouseListener;
43 import java.awt.event.MouseMotionListener;
44 import java.beans.PropertyChangeEvent;
46 public class OverviewPanel extends Panel implements Runnable,
47 MouseMotionListener, MouseListener, ViewportListenerI
49 private OverviewDimensions od;
51 private OverviewCanvas oviewCanvas;
53 private AlignViewport av;
55 private AlignmentPanel ap;
57 private boolean showHidden = true;
59 private boolean updateRunning = false;
61 private boolean draggingBox = false;
63 public OverviewPanel(AlignmentPanel alPanel)
69 od = new OverviewDimensionsShowHidden(av.getRanges(),
70 (av.isShowAnnotation() && av.getSequenceConsensusHash() != null));
72 oviewCanvas = new OverviewCanvas(od, av);
73 setLayout(new BorderLayout());
74 add(oviewCanvas, BorderLayout.CENTER);
76 setSize(new Dimension(od.getWidth(), od.getHeight()));
78 av.getRanges().addPropertyChangeListener(this);
80 addComponentListener(new ComponentAdapter()
84 public void componentResized(ComponentEvent evt)
86 if ((getWidth() != od.getWidth())
87 || (getHeight() != (od.getHeight())))
89 updateOverviewImage();
94 addMouseMotionListener(this);
96 addMouseListener(this);
98 updateOverviewImage();
103 public void mouseEntered(MouseEvent evt)
108 public void mouseExited(MouseEvent evt)
113 public void mouseClicked(MouseEvent evt)
115 if ((evt.getModifiers() & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
122 public void mouseMoved(MouseEvent evt)
124 if (od.isPositionInBox(evt.getX(), evt.getY()))
126 // display drag cursor at mouse position
127 setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
132 setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
137 public void mousePressed(MouseEvent evt)
139 if ((evt.getModifiers()
140 & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
142 if (!Platform.isAMac())
149 if (!od.isPositionInBox(evt.getX(), evt.getY()))
151 // don't do anything if the mouse press is in the overview's box
152 // (wait to see if it's a drag instead)
153 // otherwise update the viewport
154 od.updateViewportFromMouse(evt.getX(), evt.getY(),
155 av.getAlignment().getHiddenSequences(),
156 av.getAlignment().getHiddenColumns());
161 od.setDragPoint(evt.getX(), evt.getY(),
162 av.getAlignment().getHiddenSequences(),
163 av.getAlignment().getHiddenColumns());
169 public void mouseReleased(MouseEvent evt)
178 public void mouseDragged(MouseEvent evt)
180 if ((evt.getModifiers() & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
182 if (!Platform.isAMac())
191 // set the mouse position as a fixed point in the box
192 // and drag relative to that position
193 od.adjustViewportFromMouse(evt.getX(), evt.getY(),
194 av.getAlignment().getHiddenSequences(),
195 av.getAlignment().getHiddenColumns());
199 od.updateViewportFromMouse(evt.getX(), evt.getY(),
200 av.getAlignment().getHiddenSequences(),
201 av.getAlignment().getHiddenColumns());
203 ap.paintAlignment(false);
208 * Updates the overview image when the related alignment panel is updated
210 public void updateOverviewImage()
212 if (oviewCanvas == null)
215 * panel has been disposed
220 if ((getSize().width > 0) && (getSize().height > 0))
222 od.setWidth(getSize().width);
223 od.setHeight(getSize().height);
225 setSize(new Dimension(od.getWidth(), od.getHeight()));
231 oviewCanvas.restartDraw();
235 updateRunning = true;
237 Thread thread = new Thread(this);
240 updateRunning = false;
246 oviewCanvas.draw(av.isShowSequenceFeatures(),
247 (av.isShowAnnotation() && av
248 .getAlignmentConservationAnnotation() != null),
249 ap.seqPanel.seqCanvas.getFeatureRenderer());
254 * Update the overview panel box when the associated alignment panel is
258 private void setBoxPosition()
260 od.setBoxPosition(av.getAlignment()
261 .getHiddenSequences(), av
262 .getAlignment().getHiddenColumns());
267 * Displays the popup menu and acts on user input
269 private void showPopupMenu(MouseEvent e)
271 PopupMenu popup = new PopupMenu();
272 ItemListener menuListener = new ItemListener()
275 public void itemStateChanged(ItemEvent e)
277 toggleHiddenColumns();
280 CheckboxMenuItem item = new CheckboxMenuItem(
281 MessageManager.getString("label.togglehidden"));
282 item.setState(showHidden);
284 item.addItemListener(menuListener);
286 popup.show(this, e.getX(), e.getY());
290 public void propertyChange(PropertyChangeEvent evt)
296 * Toggle overview display between showing hidden columns and hiding hidden columns
298 private void toggleHiddenColumns()
303 od = new OverviewDimensionsHideHidden(av.getRanges(),
304 (av.isShowAnnotation() && av
305 .getAlignmentConservationAnnotation() != null));
310 od = new OverviewDimensionsShowHidden(av.getRanges(),
311 (av.isShowAnnotation() && av
312 .getAlignmentConservationAnnotation() != null));
314 oviewCanvas.resetOviewDims(od);
315 updateOverviewImage();
319 * Removes this object as a property change listener, and nulls references
321 protected void dispose()
325 av.getRanges().removePropertyChangeListener(this);