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.Frame;
35 import java.awt.Panel;
36 import java.awt.PopupMenu;
37 import java.awt.event.ComponentAdapter;
38 import java.awt.event.ComponentEvent;
39 import java.awt.event.InputEvent;
40 import java.awt.event.ItemEvent;
41 import java.awt.event.ItemListener;
42 import java.awt.event.MouseEvent;
43 import java.awt.event.MouseListener;
44 import java.awt.event.MouseMotionListener;
45 import java.beans.PropertyChangeEvent;
47 public class OverviewPanel extends Panel implements Runnable,
48 MouseMotionListener, MouseListener, ViewportListenerI
50 private OverviewDimensions od;
52 private OverviewCanvas oviewCanvas;
54 private AlignViewport av;
56 private AlignmentPanel ap;
58 private boolean showHidden = true;
60 private boolean updateRunning = false;
62 private boolean draggingBox = false;
64 public OverviewPanel(AlignmentPanel alPanel)
70 od = new OverviewDimensionsShowHidden(av.getRanges(),
71 (av.isShowAnnotation()
72 && av.getSequenceConsensusHash() != null));
74 oviewCanvas = new OverviewCanvas(od, av);
75 setLayout(new BorderLayout());
76 add(oviewCanvas, BorderLayout.CENTER);
78 setSize(new Dimension(od.getWidth(), od.getHeight()));
80 av.getRanges().addPropertyChangeListener(this);
82 addComponentListener(new ComponentAdapter()
86 public void componentResized(ComponentEvent evt)
88 if ((getWidth() != od.getWidth())
89 || (getHeight() != (od.getHeight())))
91 updateOverviewImage();
96 addMouseMotionListener(this);
98 addMouseListener(this);
100 updateOverviewImage();
105 public void mouseEntered(MouseEvent evt)
110 public void mouseExited(MouseEvent evt)
115 public void mouseClicked(MouseEvent evt)
117 if ((evt.getModifiers()
118 & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
125 public void mouseMoved(MouseEvent evt)
127 if (od.isPositionInBox(evt.getX(), evt.getY()))
129 // display drag cursor at mouse position
130 setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
135 setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
140 public void mousePressed(MouseEvent evt)
142 if ((evt.getModifiers()
143 & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
145 if (!Platform.isAMac())
152 // don't do anything if the mouse press is in the overview's box
153 // (wait to see if it's a drag instead)
154 // otherwise update the viewport
155 if (!od.isPositionInBox(evt.getX(), evt.getY()))
158 od.updateViewportFromMouse(evt.getX(), evt.getY(),
159 av.getAlignment().getHiddenSequences(),
160 av.getAlignment().getHiddenColumns());
165 od.setDragPoint(evt.getX(), evt.getY(),
166 av.getAlignment().getHiddenSequences(),
167 av.getAlignment().getHiddenColumns());
173 public void mouseReleased(MouseEvent evt)
178 public void mouseDragged(MouseEvent evt)
180 if ((evt.getModifiers()
181 & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
183 if (!Platform.isAMac())
192 // set the mouse position as a fixed point in the box
193 // and drag relative to that position
194 od.adjustViewportFromMouse(evt.getX(), evt.getY(),
195 av.getAlignment().getHiddenSequences(),
196 av.getAlignment().getHiddenColumns());
200 od.updateViewportFromMouse(evt.getX(), evt.getY(),
201 av.getAlignment().getHiddenSequences(),
202 av.getAlignment().getHiddenColumns());
204 ap.paintAlignment(false, false);
209 * Updates the overview image when the related alignment panel is updated
211 public void updateOverviewImage()
213 if (oviewCanvas == null)
216 * panel has been disposed
221 if ((getSize().width > 0) && (getSize().height > 0))
223 od.setWidth(getSize().width);
224 od.setHeight(getSize().height);
226 setSize(new Dimension(od.getWidth(), od.getHeight()));
232 oviewCanvas.restartDraw();
236 updateRunning = true;
238 Thread thread = new Thread(this);
241 updateRunning = false;
247 oviewCanvas.draw(av.isShowSequenceFeatures(),
248 (av.isShowAnnotation()
249 && av.getAlignmentConservationAnnotation() != null),
250 ap.seqPanel.seqCanvas.getFeatureRenderer());
255 * Update the overview panel box when the associated alignment panel is
259 private void setBoxPosition()
261 od.setBoxPosition(av.getAlignment().getHiddenSequences(),
262 av.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()
305 && av.getAlignmentConservationAnnotation() != null));
310 od = new OverviewDimensionsShowHidden(av.getRanges(),
311 (av.isShowAnnotation()
312 && av.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);
326 Frame parent = (Frame) getParent();
328 parent.setVisible(false);