X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FOverviewPanel.java;h=51d7a845e600bf5a55a5ed59166fdb5acb7f6973;hb=b54c409c5389556da183e96d59cc6aaea60e0e3f;hp=0b11189206e5a55f9b88e3ab289e07951ace956a;hpb=b2f9a8d7bce642ff4011bc6d49e02bb0569fbb11;p=jalview.git diff --git a/src/jalview/gui/OverviewPanel.java b/src/jalview/gui/OverviewPanel.java index 0b11189..51d7a84 100755 --- a/src/jalview/gui/OverviewPanel.java +++ b/src/jalview/gui/OverviewPanel.java @@ -1,131 +1,144 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1) - * Copyright (C) 2014 The Jalview Authors + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors * * This file is part of Jalview. * * Jalview is free software: you can redistribute it and/or * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. + * as published by the Free Software Foundation, either version 3 + * of the License, or (at your option) any later version. * * Jalview is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty * of MERCHANTABILITY or FITNESS FOR A PARTICULAR * PURPOSE. See the GNU General Public License for more details. * - * You should have received a copy of the GNU General Public License along with Jalview. If not, see . + * You should have received a copy of the GNU General Public License + * along with Jalview. If not, see . * The Jalview Authors are detailed in the 'AUTHORS' file. */ package jalview.gui; -import jalview.renderer.AnnotationRenderer; - -import java.awt.*; -import java.awt.event.*; -import java.awt.image.*; -import javax.swing.*; +import jalview.bin.Cache; +import jalview.renderer.OverviewRenderer; +import jalview.util.MessageManager; +import jalview.util.Platform; +import jalview.viewmodel.OverviewDimensions; +import jalview.viewmodel.OverviewDimensionsHideHidden; +import jalview.viewmodel.OverviewDimensionsShowHidden; +import jalview.viewmodel.ViewportListenerI; + +import java.awt.BorderLayout; +import java.awt.Cursor; +import java.awt.Dimension; +import java.awt.event.ActionEvent; +import java.awt.event.ActionListener; +import java.awt.event.ComponentAdapter; +import java.awt.event.ComponentEvent; +import java.awt.event.MouseAdapter; +import java.awt.event.MouseEvent; +import java.awt.event.MouseMotionAdapter; +import java.beans.PropertyChangeEvent; + +import javax.swing.JCheckBoxMenuItem; +import javax.swing.JPanel; +import javax.swing.JPopupMenu; +import javax.swing.SwingUtilities; /** - * DOCUMENT ME! + * Panel displaying an overview of the full alignment, with an interactive box + * representing the viewport onto the alignment. * * @author $author$ * @version $Revision$ */ -public class OverviewPanel extends JPanel implements Runnable +public class OverviewPanel extends JPanel + implements Runnable, ViewportListenerI { - BufferedImage miniMe; - - AlignViewport av; - - AlignmentPanel ap; - - final AnnotationRenderer renderer = new AnnotationRenderer(); - - float scalew = 1f; - - float scaleh = 1f; + private OverviewDimensions od; - int width; + private OverviewCanvas oviewCanvas; - int sequencesHeight; + private AlignViewport av; - int graphHeight = 20; + private AlignmentPanel ap; - int boxX = -1; + private JCheckBoxMenuItem displayToggle; - int boxY = -1; + private boolean showHidden = true; - int boxWidth = -1; + private boolean draggingBox = false; - int boxHeight = -1; - - boolean resizing = false; - - // Can set different properties in this seqCanvas than - // main visible SeqCanvas - SequenceRenderer sr; - - FeatureRenderer fr; + private ProgressPanel progressPanel; /** * Creates a new OverviewPanel object. * - * @param ap - * DOCUMENT ME! + * @param alPanel + * The alignment panel which is shown in the overview panel */ - public OverviewPanel(AlignmentPanel ap) + public OverviewPanel(AlignmentPanel alPanel) { - this.av = ap.av; - this.ap = ap; - setLayout(null); + this.av = alPanel.av; + this.ap = alPanel; - sr = new SequenceRenderer(av); - sr.renderGaps = false; - sr.forOverview = true; - fr = new FeatureRenderer(ap); - - // scale the initial size of overviewpanel to shape of alignment - float initialScale = (float) av.getAlignment().getWidth() - / (float) av.getAlignment().getHeight(); - - if (av.getAlignmentConservationAnnotation() == null) + showHidden = Cache.getDefault(Preferences.SHOW_OV_HIDDEN_AT_START, + true); + if (showHidden) { - graphHeight = 0; - } - - if (av.getAlignment().getWidth() > av.getAlignment().getHeight()) - { - // wider - width = 400; - sequencesHeight = (int) (400f / initialScale); - if (sequencesHeight < 40) - { - sequencesHeight = 40; - } + od = new OverviewDimensionsShowHidden(av.getRanges(), + (av.isShowAnnotation() + && av.getAlignmentConservationAnnotation() != null)); } else { - // taller - width = (int) (400f * initialScale); - sequencesHeight = 300; - - if (width < 120) - { - width = 120; - } + od = new OverviewDimensionsHideHidden(av.getRanges(), + (av.isShowAnnotation() + && av.getAlignmentConservationAnnotation() != null)); } + setLayout(new BorderLayout()); + progressPanel = new ProgressPanel(OverviewRenderer.UPDATE, + MessageManager.getString("label.oview_calc"), getWidth()); + this.add(progressPanel, BorderLayout.SOUTH); + oviewCanvas = new OverviewCanvas(od, av, progressPanel); + + add(oviewCanvas, BorderLayout.CENTER); + + av.getRanges().addPropertyChangeListener(this); + + // without this the overview window does not size to fit the overview canvas + setPreferredSize(new Dimension(od.getWidth(), od.getHeight())); + addComponentListener(new ComponentAdapter() { @Override public void componentResized(ComponentEvent evt) { - if ((getWidth() != width) - || (getHeight() != (sequencesHeight + graphHeight))) + // Resize is called on the initial display of the overview. + // This code adjusts sizes to account for the progress bar if it has not + // already been accounted for, which triggers another resize call for + // the correct sizing, at which point the overview image is updated. + // (This avoids a double recalculation of the image.) + if (getWidth() == od.getWidth() && getHeight() == od.getHeight() + + progressPanel.getHeight()) { updateOverviewImage(); } + else + { + if ((getWidth() > 0) && (getHeight() > 0)) + { + od.setWidth(getWidth()); + od.setHeight(getHeight() - progressPanel.getHeight()); + } + + setPreferredSize(new Dimension(od.getWidth(), + od.getHeight() + progressPanel.getHeight())); + } } + }); addMouseMotionListener(new MouseMotionAdapter() @@ -133,13 +146,37 @@ public class OverviewPanel extends JPanel implements Runnable @Override public void mouseDragged(MouseEvent evt) { - if (!av.wrapAlignment) + if (!SwingUtilities.isRightMouseButton(evt)) { - // TODO: feature: jv2.5 detect shift drag and update selection from - // it. - boxX = evt.getX(); - boxY = evt.getY(); - checkValid(); + if (draggingBox) + { + // set the mouse position as a fixed point in the box + // and drag relative to that position + od.adjustViewportFromMouse(evt.getX(), evt.getY(), + av.getAlignment().getHiddenSequences(), + av.getAlignment().getHiddenColumns()); + } + else + { + od.updateViewportFromMouse(evt.getX(), evt.getY(), + av.getAlignment().getHiddenSequences(), + av.getAlignment().getHiddenColumns()); + } + } + } + + @Override + public void mouseMoved(MouseEvent evt) + { + if (od.isPositionInBox(evt.getX(), evt.getY())) + { + // display drag cursor at mouse position + setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR)); + } + else + { + // reset cursor + setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR)); } } }); @@ -149,324 +186,179 @@ public class OverviewPanel extends JPanel implements Runnable @Override public void mousePressed(MouseEvent evt) { - if (!av.wrapAlignment) + if (SwingUtilities.isRightMouseButton(evt)) + { + if (!Platform.isAMac()) + { + showPopupMenu(evt); + } + } + else + { + // don't do anything if the mouse press is in the overview's box + // (wait to see if it's a drag instead) + // otherwise update the viewport + if (!od.isPositionInBox(evt.getX(), evt.getY())) + { + draggingBox = false; + od.updateViewportFromMouse(evt.getX(), evt.getY(), + av.getAlignment().getHiddenSequences(), + av.getAlignment().getHiddenColumns()); + } + else + { + draggingBox = true; + od.setDragPoint(evt.getX(), evt.getY(), + av.getAlignment().getHiddenSequences(), + av.getAlignment().getHiddenColumns()); + } + } + } + + @Override + public void mouseClicked(MouseEvent evt) + { + if (SwingUtilities.isRightMouseButton(evt)) { - boxX = evt.getX(); - boxY = evt.getY(); - checkValid(); + showPopupMenu(evt); } } }); - - updateOverviewImage(); } - /** - * DOCUMENT ME! + /* + * Displays the popup menu and acts on user input */ - void checkValid() + private void showPopupMenu(MouseEvent e) { - if (boxY < 0) - { - boxY = 0; - } - - if (boxY > (sequencesHeight - boxHeight)) - { - boxY = sequencesHeight - boxHeight + 1; - } - - if (boxX < 0) - { - boxX = 0; - } - - if (boxX > (width - boxWidth)) + JPopupMenu popup = new JPopupMenu(); + ActionListener menuListener = new ActionListener() { - if (av.hasHiddenColumns()) + @Override + public void actionPerformed(ActionEvent event) { - // Try smallest possible box - boxWidth = (int) ((av.endRes - av.startRes + 1) * av.getCharWidth() * scalew); + // switch on/off the hidden columns view + toggleHiddenColumns(); + displayToggle.setSelected(showHidden); } - boxX = width - boxWidth; - } - - int col = (int) (boxX / scalew / av.getCharWidth()); - int row = (int) (boxY / scaleh / av.getCharHeight()); + }; + displayToggle = new JCheckBoxMenuItem( + MessageManager.getString("label.togglehidden")); + displayToggle.setEnabled(true); + displayToggle.setSelected(showHidden); + popup.add(displayToggle); + displayToggle.addActionListener(menuListener); + popup.show(this, e.getX(), e.getY()); + } - if (av.hasHiddenColumns()) + /* + * Toggle overview display between showing hidden columns and hiding hidden columns + */ + private void toggleHiddenColumns() + { + if (showHidden) { - if (!av.getColumnSelection().isVisible(col)) - { - return; - } - - col = av.getColumnSelection().findColumnPosition(col); + showHidden = false; + od = new OverviewDimensionsHideHidden(av.getRanges(), + (av.isShowAnnotation() + && av.getAlignmentConservationAnnotation() != null)); } - - if (av.hasHiddenRows()) + else { - row = av.getAlignment().getHiddenSequences() - .findIndexWithoutHiddenSeqs(row); + showHidden = true; + od = new OverviewDimensionsShowHidden(av.getRanges(), + (av.isShowAnnotation() + && av.getAlignmentConservationAnnotation() != null)); } - - ap.setScrollValues(col, row); - + oviewCanvas.resetOviewDims(od); + updateOverviewImage(); + setBoxPosition(); } /** - * DOCUMENT ME! + * Updates the overview image when the related alignment panel is updated */ public void updateOverviewImage() { - if (resizing) + if (oviewCanvas == null) { - resizeAgain = true; + /* + * panel has been disposed + */ return; } - resizing = true; - if ((getWidth() > 0) && (getHeight() > 0)) { - width = getWidth(); - sequencesHeight = getHeight() - graphHeight; + od.setWidth(getWidth()); + od.setHeight(getHeight() - progressPanel.getHeight()); } + + setPreferredSize(new Dimension(od.getWidth(), + od.getHeight() + progressPanel.getHeight())); - setPreferredSize(new Dimension(width, sequencesHeight + graphHeight)); + if (oviewCanvas.restartDraw()) + { + return; + } Thread thread = new Thread(this); thread.start(); repaint(); - } - // This is set true if the user resizes whilst - // the overview is being calculated - boolean resizeAgain = false; + + } - /** - * DOCUMENT ME! - */ @Override public void run() { - miniMe = null; - - if (av.showSequenceFeatures) - { - fr.transferSettings(ap.seqPanel.seqCanvas.getFeatureRenderer()); - } - - int alwidth = av.getAlignment().getWidth(); - int alheight = av.getAlignment().getHeight() - + av.getAlignment().getHiddenSequences().getSize(); - - setPreferredSize(new Dimension(width, sequencesHeight + graphHeight)); - - int fullsizeWidth = alwidth * av.getCharWidth(); - int fullsizeHeight = alheight * av.getCharHeight(); - - scalew = (float) width / (float) fullsizeWidth; - scaleh = (float) sequencesHeight / (float) fullsizeHeight; - - miniMe = new BufferedImage(width, sequencesHeight + graphHeight, - BufferedImage.TYPE_INT_RGB); - - Graphics mg = miniMe.getGraphics(); - mg.setColor(Color.orange); - mg.fillRect(0, 0, width, miniMe.getHeight()); - - float sampleCol = (float) alwidth / (float) width; - float sampleRow = (float) alheight / (float) sequencesHeight; - - int lastcol = -1, lastrow = -1; - int color = Color.white.getRGB(); - int row, col; - jalview.datamodel.SequenceI seq; - boolean hiddenRow = false; - for (row = 0; row < sequencesHeight; row++) - { - if ((int) (row * sampleRow) == lastrow) - { - // No need to recalculate the colours, - // Just copy from the row above - for (col = 0; col < width; col++) - { - miniMe.setRGB(col, row, miniMe.getRGB(col, row - 1)); - } - continue; - } - - lastrow = (int) (row * sampleRow); - - hiddenRow = false; - if (av.hasHiddenRows()) - { - seq = av.getAlignment().getHiddenSequences() - .getHiddenSequence(lastrow); - if (seq == null) - { - int index = av.getAlignment().getHiddenSequences() - .findIndexWithoutHiddenSeqs(lastrow); - - seq = av.getAlignment().getSequenceAt(index); - } - else - { - hiddenRow = true; - } - } - else - { - seq = av.getAlignment().getSequenceAt(lastrow); - } - - if (seq == null) - { - System.out.println(lastrow + " null"); - continue; - } - - for (col = 0; col < width; col++) - { - if ((int) (col * sampleCol) == lastcol - && (int) (row * sampleRow) == lastrow) - { - miniMe.setRGB(col, row, color); - continue; - } - - lastcol = (int) (col * sampleCol); - - if (seq.getLength() > lastcol) - { - color = sr.getResidueBoxColour(seq, lastcol).getRGB(); - - if (av.showSequenceFeatures) - { - color = fr.findFeatureColour(color, seq, lastcol); - } - } - else - { - color = -1; // White - } - - if (hiddenRow - || (av.hasHiddenColumns() && !av.getColumnSelection() - .isVisible(lastcol))) - { - color = new Color(color).darker().darker().getRGB(); - } - - miniMe.setRGB(col, row, color); - - } - } - - if (av.getAlignmentConservationAnnotation() != null) + if (oviewCanvas != null) { - renderer.updateFromAlignViewport(av); - for (col = 0; col < width; col++) - { - lastcol = (int) (col * sampleCol); - { - mg.translate(col, sequencesHeight); - renderer.drawGraph(mg, av.getAlignmentConservationAnnotation(), - av.getAlignmentConservationAnnotation().annotations, - (int) (sampleCol) + 1, graphHeight, - (int) (col * sampleCol), (int) (col * sampleCol) + 1); - mg.translate(-col, -sequencesHeight); - } - } - } - System.gc(); - - resizing = false; - - setBoxPosition(); - - if (resizeAgain) - { - resizeAgain = false; - updateOverviewImage(); + oviewCanvas.draw(av.isShowSequenceFeatures(), + (av.isShowAnnotation() + && av.getAlignmentConservationAnnotation() != null), + ap.getSeqPanel().seqCanvas.getFeatureRenderer()); + setBoxPosition(); } } /** - * DOCUMENT ME! + * Update the overview panel box when the associated alignment panel is + * changed + * */ - public void setBoxPosition() + private void setBoxPosition() { - int fullsizeWidth = av.getAlignment().getWidth() * av.getCharWidth(); - int fullsizeHeight = (av.getAlignment().getHeight() + av.getAlignment() - .getHiddenSequences().getSize()) - * av.getCharHeight(); - - int startRes = av.getStartRes(); - int endRes = av.getEndRes(); - - if (av.hasHiddenColumns()) - { - startRes = av.getColumnSelection().adjustForHiddenColumns(startRes); - endRes = av.getColumnSelection().adjustForHiddenColumns(endRes); - } - - int startSeq = av.startSeq; - int endSeq = av.endSeq; - - if (av.hasHiddenRows()) - { - startSeq = av.getAlignment().getHiddenSequences() - .adjustForHiddenSeqs(startSeq); - - endSeq = av.getAlignment().getHiddenSequences() - .adjustForHiddenSeqs(endSeq); - - } - - scalew = (float) width / (float) fullsizeWidth; - scaleh = (float) sequencesHeight / (float) fullsizeHeight; - - boxX = (int) (startRes * av.getCharWidth() * scalew); - boxY = (int) (startSeq * av.getCharHeight() * scaleh); - - if (av.hasHiddenColumns()) - { - boxWidth = (int) ((endRes - startRes + 1) * av.getCharWidth() * scalew); - } - else + if (od != null) { - boxWidth = (int) ((endRes - startRes + 1) * av.getCharWidth() * scalew); + od.setBoxPosition(av.getAlignment().getHiddenSequences(), + av.getAlignment().getHiddenColumns()); + repaint(); } + } - boxHeight = (int) ((endSeq - startSeq) * av.getCharHeight() * scaleh); - - repaint(); + @Override + public void propertyChange(PropertyChangeEvent evt) + { + setBoxPosition(); } /** - * DOCUMENT ME! - * - * @param g - * DOCUMENT ME! + * Removes this object as a property change listener, and nulls references */ - @Override - public void paintComponent(Graphics g) + protected void dispose() { - if (resizing) + try { - g.setColor(Color.white); - g.fillRect(0, 0, getWidth(), getHeight()); - } - else if (miniMe != null) + av.getRanges().removePropertyChangeListener(this); + oviewCanvas.dispose(); + } finally { - g.drawImage(miniMe, 0, 0, this); + progressPanel = null; + av = null; + oviewCanvas = null; + ap = null; + od = null; } - - g.setColor(Color.red); - g.drawRect(boxX, boxY, boxWidth, boxHeight); - g.drawRect(boxX + 1, boxY + 1, boxWidth - 2, boxHeight - 2); - } }