X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FIdPanel.java;h=f0aefb1438fc998ff375e38abc873b7797f864dc;hb=f4766a7bbcfae845fc95923b01fa14ff83d589ff;hp=39afd2c2de07a28d8ac542f65742fef90204996f;hpb=10b903bf6b22d53e8920091efb2145d6b6a677ba;p=jalview.git diff --git a/src/jalview/gui/IdPanel.java b/src/jalview/gui/IdPanel.java index 39afd2c..f0aefb1 100755 --- a/src/jalview/gui/IdPanel.java +++ b/src/jalview/gui/IdPanel.java @@ -1,6 +1,6 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2) - * 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. * @@ -20,30 +20,40 @@ */ package jalview.gui; -import java.awt.*; -import java.awt.event.*; -import java.util.List; -import java.util.Vector; - -import javax.swing.*; - -import jalview.datamodel.*; +import jalview.datamodel.Sequence; +import jalview.datamodel.SequenceFeature; +import jalview.datamodel.SequenceGroup; +import jalview.datamodel.SequenceI; import jalview.io.SequenceAnnotationReport; import jalview.util.MessageManager; -import jalview.util.UrlLink; +import jalview.util.Platform; +import jalview.viewmodel.AlignmentViewport; + +import java.awt.BorderLayout; +import java.awt.event.MouseEvent; +import java.awt.event.MouseListener; +import java.awt.event.MouseMotionListener; +import java.awt.event.MouseWheelEvent; +import java.awt.event.MouseWheelListener; +import java.util.List; + +import javax.swing.JPanel; +import javax.swing.SwingUtilities; +import javax.swing.ToolTipManager; /** - * DOCUMENT ME! + * This panel hosts alignment sequence ids and responds to mouse clicks on them, + * as well as highlighting ids matched by a search from the Find menu. * * @author $author$ * @version $Revision$ */ -public class IdPanel extends JPanel implements MouseListener, - MouseMotionListener, MouseWheelListener +public class IdPanel extends JPanel + implements MouseListener, MouseMotionListener, MouseWheelListener { - protected IdCanvas idCanvas; + private IdCanvas idCanvas; - protected AlignViewport av; + protected AlignmentViewport av; protected AlignmentPanel alignPanel; @@ -64,19 +74,17 @@ public class IdPanel extends JPanel implements MouseListener, * Creates a new IdPanel object. * * @param av - * DOCUMENT ME! * @param parent - * DOCUMENT ME! */ public IdPanel(AlignViewport av, AlignmentPanel parent) { this.av = av; alignPanel = parent; - idCanvas = new IdCanvas(av); + setIdCanvas(new IdCanvas(av)); linkImageURL = getClass().getResource("/images/link.gif").toString(); seqAnnotReport = new SequenceAnnotationReport(linkImageURL); setLayout(new BorderLayout()); - add(idCanvas, BorderLayout.CENTER); + add(getIdCanvas(), BorderLayout.CENTER); addMouseListener(this); addMouseMotionListener(this); addMouseWheelListener(this); @@ -84,7 +92,8 @@ public class IdPanel extends JPanel implements MouseListener, } /** - * DOCUMENT ME! + * Respond to mouse movement by constructing tooltip text for the sequence id + * under the mouse. * * @param e * DOCUMENT ME! @@ -92,33 +101,32 @@ public class IdPanel extends JPanel implements MouseListener, @Override public void mouseMoved(MouseEvent e) { - SeqPanel sp = alignPanel.seqPanel; + SeqPanel sp = alignPanel.getSeqPanel(); int seq = Math.max(0, sp.findSeq(e)); if (seq > -1 && seq < av.getAlignment().getHeight()) { SequenceI sequence = av.getAlignment().getSequenceAt(seq); - StringBuffer tip = new StringBuffer(); - seqAnnotReport - .createSequenceAnnotationReport(tip, sequence, - av.isShowDbRefs(), av.isShowNpFeats(), - sp.seqCanvas.fr.minmax); - setToolTipText("" + sequence.getDisplayId(true) + " " - + tip.toString() + ""); + StringBuilder tip = new StringBuilder(64); + seqAnnotReport.createTooltipAnnotationReport(tip, sequence, + av.isShowDBRefs(), av.isShowNPFeats(), + sp.seqCanvas.fr.getMinMax()); + setToolTipText(JvSwingUtils.wrapTooltip(true, + sequence.getDisplayId(true) + " " + tip.toString())); } } /** - * DOCUMENT ME! + * Responds to a mouse drag by selecting the sequences under the dragged + * region. * * @param e - * DOCUMENT ME! */ @Override public void mouseDragged(MouseEvent e) { mouseDragging = true; - int seq = Math.max(0, alignPanel.seqPanel.findSeq(e)); + int seq = Math.max(0, alignPanel.getSeqPanel().findSeq(e)); if (seq < lastid) { @@ -130,9 +138,12 @@ public class IdPanel extends JPanel implements MouseListener, } lastid = seq; - alignPanel.paintAlignment(true); + alignPanel.paintAlignment(false); } + /** + * Response to the mouse wheel by scrolling the alignment panel. + */ @Override public void mouseWheelMoved(MouseWheelEvent e) { @@ -141,97 +152,65 @@ public class IdPanel extends JPanel implements MouseListener, { if (e.isShiftDown()) { - alignPanel.scrollRight(true); - + av.getRanges().scrollRight(true); } - else + else if (!av.getWrapAlignment()) { - alignPanel.scrollUp(false); + av.getRanges().scrollUp(false); } } else { if (e.isShiftDown()) { - alignPanel.scrollRight(false); + av.getRanges().scrollRight(false); } - else + else if (!av.getWrapAlignment()) { - alignPanel.scrollUp(true); + av.getRanges().scrollUp(true); } } } /** - * DOCUMENT ME! + * Handle a mouse click event. Currently only responds to a double-click. The + * action is to try to open a browser window at a URL that searches for the + * selected sequence id. The search URL is configured in Preferences | + * Connections | URL link from Sequence ID. For example: + * + * http://www.ebi.ac.uk/ebisearch/search.ebi?db=allebi&query=$SEQUENCE_ID$ * * @param e - * DOCUMENT ME! */ @Override public void mouseClicked(MouseEvent e) { - if (e.getClickCount() < 2) - { - return; - } - - java.util.Vector links = Preferences.sequenceURLLinks; - if (links == null || links.size() < 1) + /* + * Ignore single click. Ignore 'left' click followed by 'right' click (user + * selects a row then its pop-up menu). + */ + if (e.getClickCount() < 2 || SwingUtilities.isRightMouseButton(e)) { + // reinstate isRightMouseButton check to ignore mouse-related popup events + // note - this does nothing on default MacBookPro force-trackpad config! return; } - int seq = alignPanel.seqPanel.findSeq(e); - String url = null; - int i = 0; + int seq = alignPanel.getSeqPanel().findSeq(e); String id = av.getAlignment().getSequenceAt(seq).getName(); - while (url == null && i < links.size()) - { - // DEFAULT LINK IS FIRST IN THE LINK LIST - // BUT IF ITS A REGEX AND DOES NOT MATCH THE NEXT ONE WILL BE TRIED - url = links.elementAt(i++).toString(); - jalview.util.UrlLink urlLink = null; - try - { - urlLink = new UrlLink(url); - } catch (Exception foo) - { - jalview.bin.Cache.log.error("Exception for URLLink '" + url + "'", - foo); - url = null; - continue; - } - ; - if (!urlLink.isValid()) - { - jalview.bin.Cache.log.error(urlLink.getInvalidMessage()); - url = null; - continue; - } + String url = Preferences.sequenceUrlLinks.getPrimaryUrl(id); - String urls[] = urlLink.makeUrls(id, true); - if (urls == null || urls[0] == null || urls[0].length() < 4) - { - url = null; - continue; - } - // just take first URL made from regex - url = urls[1]; - } try { jalview.util.BrowserLauncher.openURL(url); } catch (Exception ex) { - JOptionPane - .showInternalMessageDialog( - Desktop.desktop, - MessageManager.getString("label.web_browser_not_found_unix"), - MessageManager.getString("label.web_browser_not_found"), JOptionPane.WARNING_MESSAGE); + JvOptionPane.showInternalMessageDialog(Desktop.desktop, + MessageManager.getString("label.web_browser_not_found_unix"), + MessageManager.getString("label.web_browser_not_found"), + JvOptionPane.WARNING_MESSAGE); ex.printStackTrace(); } - } /** @@ -263,72 +242,66 @@ public class IdPanel extends JPanel implements MouseListener, return; } - if (mouseDragging && (e.getY() < 0) && (av.getStartSeq() > 0)) + if (mouseDragging && (e.getY() < 0) + && (av.getRanges().getStartSeq() > 0)) { scrollThread = new ScrollThread(true); } if (mouseDragging && (e.getY() >= getHeight()) - && (av.getAlignment().getHeight() > av.getEndSeq())) + && (av.getAlignment().getHeight() > av.getRanges().getEndSeq())) { scrollThread = new ScrollThread(false); } } /** - * DOCUMENT ME! + * Respond to a mouse press. Does nothing for (left) double-click as this is + * handled by mouseClicked(). + * + * Right mouse down - construct and show context menu. + * + * Ctrl-down or Shift-down - add to or expand current selection group if there + * is one. + * + * Mouse down - select this sequence. * * @param e - * DOCUMENT ME! */ @Override public void mousePressed(MouseEvent e) { - if (e.getClickCount() == 2) + if (e.getClickCount() == 2 && SwingUtilities.isLeftMouseButton(e)) { return; } - int seq = alignPanel.seqPanel.findSeq(e); - - if (javax.swing.SwingUtilities.isRightMouseButton(e)) + if (e.isPopupTrigger()) // Mac reports this in mousePressed { - Sequence sq = (Sequence) av.getAlignment().getSequenceAt(seq); - // build a new links menu based on the current links + any non-positional - // features - Vector nlinks = new Vector(Preferences.sequenceURLLinks); - SequenceFeature sf[] = sq == null ? null : sq.getDatasetSequence() - .getSequenceFeatures(); - for (int sl = 0; sf != null && sl < sf.length; sl++) - { - if (sf[sl].begin == sf[sl].end && sf[sl].begin == 0) - { - if (sf[sl].links != null && sf[sl].links.size() > 0) - { - for (int l = 0, lSize = sf[sl].links.size(); l < lSize; l++) - { - nlinks.addElement(sf[sl].links.elementAt(l)); - } - } - } - } - - jalview.gui.PopupMenu pop = new jalview.gui.PopupMenu(alignPanel, sq, - nlinks, new Vector(Preferences.getGroupURLLinks())); - pop.show(this, e.getX(), e.getY()); + showPopupMenu(e); + return; + } + /* + * defer right-mouse click handling to mouseReleased on Windows + * (where isPopupTrigger() will answer true) + * NB isRightMouseButton is also true for Cmd-click on Mac + */ + if (SwingUtilities.isRightMouseButton(e) && !Platform.isAMac()) + { return; } if ((av.getSelectionGroup() == null) - || ((!e.isControlDown() && !e.isShiftDown()) && av - .getSelectionGroup() != null)) + || (!jalview.util.Platform.isControlDown(e) && !e.isShiftDown() + && av.getSelectionGroup() != null)) { av.setSelectionGroup(new SequenceGroup()); av.getSelectionGroup().setStartRes(0); av.getSelectionGroup().setEndRes(av.getAlignment().getWidth() - 1); } + int seq = alignPanel.getSeqPanel().findSeq(e); if (e.isShiftDown() && (lastid != -1)) { selectSeqs(lastid, seq); @@ -337,14 +310,48 @@ public class IdPanel extends JPanel implements MouseListener, { selectSeq(seq); } - alignPanel.paintAlignment(true); + + av.isSelectionGroupChanged(true); + + alignPanel.paintAlignment(false); } /** - * DOCUMENT ME! + * Build and show the popup-menu at the right-click mouse position + * + * @param e + */ + void showPopupMenu(MouseEvent e) + { + int seq2 = alignPanel.getSeqPanel().findSeq(e); + Sequence sq = (Sequence) av.getAlignment().getSequenceAt(seq2); + + /* + * build a new links menu based on the current links + * and any non-positional features + */ + List nlinks = Preferences.sequenceUrlLinks.getLinksForMenu(); + List features = sq.getFeatures().getNonPositionalFeatures(); + for (SequenceFeature sf : features) + { + if (sf.links != null) + { + for (String link : sf.links) + { + nlinks.add(link); + } + } + } + + PopupMenu pop = new PopupMenu(alignPanel, sq, features, + Preferences.getGroupURLLinks()); + pop.show(this, e.getX(), e.getY()); + } + + /** + * Toggle whether the sequence is part of the current selection group. * * @param seq - * DOCUMENT ME! */ void selectSeq(int seq) { @@ -355,12 +362,11 @@ public class IdPanel extends JPanel implements MouseListener, } /** - * DOCUMENT ME! + * Add contiguous rows of the alignment to the current selection group. Does + * nothing if there is no selection group. * * @param start - * DOCUMENT ME! * @param end - * DOCUMENT ME! */ void selectSeqs(int start, int end) { @@ -386,16 +392,16 @@ public class IdPanel extends JPanel implements MouseListener, for (int i = start; i <= end; i++) { - av.getSelectionGroup().addSequence( - av.getAlignment().getSequenceAt(i), i == end); + av.getSelectionGroup().addSequence(av.getAlignment().getSequenceAt(i), + i == end); } } /** - * DOCUMENT ME! + * Respond to mouse released. Refreshes the display and triggers broadcast of + * the new selection group to any listeners. * * @param e - * DOCUMENT ME! */ @Override public void mouseReleased(MouseEvent e) @@ -409,17 +415,22 @@ public class IdPanel extends JPanel implements MouseListener, PaintRefresher.Refresh(this, av.getSequenceSetId()); // always send selection message when mouse is released av.sendSelection(); + + if (e.isPopupTrigger()) // Windows reports this in mouseReleased + { + showPopupMenu(e); + } } /** - * DOCUMENT ME! + * Highlight sequence ids that match the given list, and if necessary scroll + * to the start sequence of the list. * * @param list - * DOCUMENT ME! */ public void highlightSearchResults(List list) { - idCanvas.setHighlighted(list); + getIdCanvas().setHighlighted(list); if (list == null) { @@ -429,12 +440,23 @@ public class IdPanel extends JPanel implements MouseListener, int index = av.getAlignment().findIndex(list.get(0)); // do we need to scroll the panel? - if ((av.getStartSeq() > index) || (av.getEndSeq() < index)) + if ((av.getRanges().getStartSeq() > index) + || (av.getRanges().getEndSeq() < index)) { - alignPanel.setScrollValues(av.getStartRes(), index); + av.getRanges().setStartSeq(index); } } + public IdCanvas getIdCanvas() + { + return idCanvas; + } + + public void setIdCanvas(IdCanvas idCanvas) + { + this.idCanvas = idCanvas; + } + // this class allows scrolling off the bottom of the visible alignment class ScrollThread extends Thread { @@ -460,14 +482,14 @@ public class IdPanel extends JPanel implements MouseListener, while (running) { - if (alignPanel.scrollUp(up)) + if (av.getRanges().scrollUp(up)) { // scroll was ok, so add new sequence to selection - int seq = av.getStartSeq(); + int seq = av.getRanges().getStartSeq(); if (!up) { - seq = av.getEndSeq(); + seq = av.getRanges().getEndSeq(); } if (seq < lastid)