2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
3 * Copyright (C) 2014 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.datamodel.Alignment;
24 import jalview.datamodel.AlignmentAnnotation;
25 import jalview.datamodel.Annotation;
26 import jalview.datamodel.Sequence;
27 import jalview.datamodel.SequenceGroup;
28 import jalview.datamodel.SequenceI;
29 import jalview.io.FormatAdapter;
30 import jalview.util.MessageManager;
32 import java.awt.Color;
33 import java.awt.Dimension;
35 import java.awt.FontMetrics;
36 import java.awt.Graphics;
37 import java.awt.Graphics2D;
38 import java.awt.Image;
39 import java.awt.MediaTracker;
40 import java.awt.RenderingHints;
41 import java.awt.Toolkit;
42 import java.awt.datatransfer.StringSelection;
43 import java.awt.event.ActionEvent;
44 import java.awt.event.ActionListener;
45 import java.awt.event.MouseEvent;
46 import java.awt.event.MouseListener;
47 import java.awt.event.MouseMotionListener;
48 import java.awt.geom.AffineTransform;
49 import java.awt.image.BufferedImage;
50 import java.util.Arrays;
51 import java.util.Vector;
52 import java.util.regex.Pattern;
54 import javax.swing.JCheckBoxMenuItem;
55 import javax.swing.JMenuItem;
56 import javax.swing.JPanel;
57 import javax.swing.JPopupMenu;
58 import javax.swing.SwingUtilities;
59 import javax.swing.ToolTipManager;
67 public class AnnotationLabels extends JPanel implements MouseListener,
68 MouseMotionListener, ActionListener
70 String TOGGLE_LABELSCALE = MessageManager.getString("label.scale_label_to_column");
72 String ADDNEW = MessageManager.getString("label.add_new_row");
74 String EDITNAME = MessageManager.getString("label.edit_label_description");
76 String HIDE = MessageManager.getString("label.hide_row");
78 String DELETE = MessageManager.getString("label.delete_row");
80 String SHOWALL = MessageManager.getString("label.show_all_hidden_rows");
82 String OUTPUT_TEXT = MessageManager.getString("label.export_annotation");
84 String COPYCONS_SEQ = MessageManager.getString("label.copy_consensus_sequence");
86 boolean resizePanel = false;
94 boolean resizing = false;
102 int scrollOffset = 0;
104 Font font = new Font("Arial", Font.PLAIN, 11);
106 private boolean hasHiddenRows;
109 * Creates a new AnnotationLabels object.
114 public AnnotationLabels(AlignmentPanel ap)
118 ToolTipManager.sharedInstance().registerComponent(this);
120 java.net.URL url = getClass().getResource("/images/idwidth.gif");
125 temp = java.awt.Toolkit.getDefaultToolkit().createImage(url);
130 MediaTracker mt = new MediaTracker(this);
131 mt.addImage(temp, 0);
133 } catch (Exception ex)
137 BufferedImage bi = new BufferedImage(temp.getHeight(this),
138 temp.getWidth(this), BufferedImage.TYPE_INT_RGB);
139 Graphics2D g = (Graphics2D) bi.getGraphics();
140 g.rotate(Math.toRadians(90));
141 g.drawImage(temp, 0, -bi.getWidth(this), this);
144 addMouseListener(this);
145 addMouseMotionListener(this);
146 addMouseWheelListener(ap.annotationPanel);
149 public AnnotationLabels(AlignViewport av)
160 public void setScrollOffset(int y)
167 * sets selectedRow to -2 if no annotation preset, -1 if no visible row is at
171 * coordinate position to search for a row
173 void getSelectedRow(int y)
176 AlignmentAnnotation[] aa = ap.av.getAlignment()
177 .getAlignmentAnnotation();
181 for (int i = 0; i < aa.length; i++)
189 height += aa[i].height;
207 public void actionPerformed(ActionEvent evt)
209 AlignmentAnnotation[] aa = ap.av.getAlignment()
210 .getAlignmentAnnotation();
212 if (evt.getActionCommand().equals(ADDNEW))
214 AlignmentAnnotation newAnnotation = new AlignmentAnnotation(null,
215 null, new Annotation[ap.av.getAlignment().getWidth()]);
217 if (!editLabelDescription(newAnnotation))
222 ap.av.getAlignment().addAnnotation(newAnnotation);
223 ap.av.getAlignment().setAnnotationIndex(newAnnotation, 0);
225 else if (evt.getActionCommand().equals(EDITNAME))
227 editLabelDescription(aa[selectedRow]);
230 else if (evt.getActionCommand().equals(HIDE))
232 aa[selectedRow].visible = false;
234 else if (evt.getActionCommand().equals(DELETE))
236 ap.av.getAlignment().deleteAnnotation(aa[selectedRow]);
238 else if (evt.getActionCommand().equals(SHOWALL))
240 for (int i = 0; i < aa.length; i++)
242 if (!aa[i].visible && aa[i].annotations != null)
244 aa[i].visible = true;
248 else if (evt.getActionCommand().equals(OUTPUT_TEXT))
250 new AnnotationExporter().exportAnnotations(ap,
251 new AlignmentAnnotation[]
252 { aa[selectedRow] }, null, null);
254 else if (evt.getActionCommand().equals(COPYCONS_SEQ))
256 SequenceI cons = null;
257 if (aa[selectedRow].groupRef != null)
259 cons = aa[selectedRow].groupRef.getConsensusSeq();
263 cons = av.getConsensusSeq();
267 copy_annotseqtoclipboard(cons);
271 else if (evt.getActionCommand().equals(TOGGLE_LABELSCALE))
273 aa[selectedRow].scaleColLabel = !aa[selectedRow].scaleColLabel;
283 protected void refresh()
285 ap.validateAnnotationDimensions(false);
296 boolean editLabelDescription(AlignmentAnnotation annotation)
298 EditNameDialog dialog = new EditNameDialog(annotation.label,
299 annotation.description, " Annotation Name ",
300 "Annotation Description ", "Edit Annotation Name/Description",
308 annotation.label = dialog.getName();
310 String text = dialog.getDescription();
311 if (text != null && text.length() == 0)
315 annotation.description = text;
326 public void mousePressed(MouseEvent evt)
328 getSelectedRow(evt.getY() - scrollOffset);
338 public void mouseReleased(MouseEvent evt)
340 int start = selectedRow;
341 getSelectedRow(evt.getY() - scrollOffset);
342 int end = selectedRow;
346 // Swap these annotations
347 AlignmentAnnotation startAA = ap.av.getAlignment()
348 .getAlignmentAnnotation()[start];
351 end = ap.av.getAlignment().getAlignmentAnnotation().length - 1;
353 AlignmentAnnotation endAA = ap.av.getAlignment()
354 .getAlignmentAnnotation()[end];
356 ap.av.getAlignment().getAlignmentAnnotation()[end] = startAA;
357 ap.av.getAlignment().getAlignmentAnnotation()[start] = endAA;
363 ap.annotationPanel.repaint();
372 public void mouseEntered(MouseEvent evt)
387 public void mouseExited(MouseEvent evt)
389 if (dragEvent == null)
402 public void mouseDragged(MouseEvent evt)
408 Dimension d = ap.annotationScroller.getPreferredSize();
409 int dif = evt.getY() - oldY;
411 dif /= ap.av.charHeight;
412 dif *= ap.av.charHeight;
414 if ((d.height - dif) > 20)
416 ap.annotationScroller.setPreferredSize(new Dimension(d.width,
418 d = ap.annotationSpaceFillerHolder.getPreferredSize();
419 ap.annotationSpaceFillerHolder.setPreferredSize(new Dimension(
420 d.width, d.height - dif));
421 ap.paintAlignment(true);
438 public void mouseMoved(MouseEvent evt)
440 resizePanel = evt.getY() < 10;
442 getSelectedRow(evt.getY() - scrollOffset);
445 && ap.av.getAlignment().getAlignmentAnnotation().length > selectedRow)
447 AlignmentAnnotation aa = ap.av.getAlignment()
448 .getAlignmentAnnotation()[selectedRow];
450 StringBuffer desc = new StringBuffer();
451 if (aa.description != null
452 && !aa.description.equals("New description"))
454 // TODO: we could refactor and merge this code with the code in
455 // jalview.gui.SeqPanel.mouseMoved(..) that formats sequence feature
457 desc.append(aa.getDescription(true).trim());
458 // check to see if the description is an html fragment.
459 if (desc.length() < 6
460 || (desc.substring(0, 6).toLowerCase().indexOf("<html>") < 0))
462 // clean the description ready for embedding in html
463 desc = new StringBuffer(Pattern.compile("<").matcher(desc)
464 .replaceAll("<"));
465 desc.insert(0, "<html>");
469 // remove terminating html if any
470 int i = desc.substring(desc.length() - 7).toLowerCase()
471 .lastIndexOf("</html>");
474 desc.setLength(desc.length() - 7 + i);
479 desc.append("<br/>");
485 // begin the tooltip's html fragment
486 desc.append("<html>");
490 // TODO: limit precision of score to avoid noise from imprecise doubles
491 // (64.7 becomes 64.7+/some tiny value).
492 desc.append(" Score: " + aa.score);
495 if (desc.length() > 6)
497 desc.append("</html>");
498 this.setToolTipText(desc.toString());
502 this.setToolTipText(null);
514 public void mouseClicked(MouseEvent evt)
516 final AlignmentAnnotation[] aa = ap.av.getAlignment()
517 .getAlignmentAnnotation();
518 if (SwingUtilities.isLeftMouseButton(evt))
520 if (selectedRow > -1 && selectedRow < aa.length)
522 if (aa[selectedRow].groupRef != null)
524 if (evt.getClickCount() >= 2)
526 // todo: make the ap scroll to the selection - not necessary, first
527 // click highlights/scrolls, second selects
528 ap.seqPanel.ap.idPanel.highlightSearchResults(null);
529 ap.av.setSelectionGroup(// new SequenceGroup(
530 aa[selectedRow].groupRef); // );
531 ap.paintAlignment(false);
532 PaintRefresher.Refresh(ap, ap.av.getSequenceSetId());
533 ap.av.sendSelection();
537 ap.seqPanel.ap.idPanel
538 .highlightSearchResults(aa[selectedRow].groupRef
539 .getSequences(null));
543 else if (aa[selectedRow].sequenceRef != null)
545 if (evt.getClickCount() == 1)
547 ap.seqPanel.ap.idPanel.highlightSearchResults(Arrays
548 .asList(new SequenceI[]
549 { aa[selectedRow].sequenceRef }));
551 else if (evt.getClickCount() >= 2)
553 ap.seqPanel.ap.idPanel.highlightSearchResults(null);
554 SequenceGroup sg = ap.av.getSelectionGroup();
557 // we make a copy rather than edit the current selection if no modifiers pressed
558 // see Enhancement JAL-1557
559 if (!(evt.isControlDown() || evt.isShiftDown()))
561 sg = new SequenceGroup(sg);
563 sg.addSequence(aa[selectedRow].sequenceRef, false);
565 if (evt.isControlDown())
567 sg.addOrRemove(aa[selectedRow].sequenceRef, true);
569 // notionally, we should also add intermediate sequences from last added sequence ?
570 sg.addSequence(aa[selectedRow].sequenceRef, true);
574 sg = new SequenceGroup();
576 sg.setEndRes(ap.av.getAlignment().getWidth()-1);
577 sg.addSequence(aa[selectedRow].sequenceRef, false);
579 ap.av.setSelectionGroup(sg);
580 ap.av.sendSelection();
581 ap.paintAlignment(false);
582 PaintRefresher.Refresh(ap, ap.av.getSequenceSetId());
588 if (!SwingUtilities.isRightMouseButton(evt))
593 JPopupMenu pop = new JPopupMenu(
594 MessageManager.getString("label.annotations"));
595 JMenuItem item = new JMenuItem(ADDNEW);
596 item.addActionListener(this);
601 { // let the user make everything visible again
602 item = new JMenuItem(SHOWALL);
603 item.addActionListener(this);
606 pop.show(this, evt.getX(), evt.getY());
609 item = new JMenuItem(EDITNAME);
610 item.addActionListener(this);
612 item = new JMenuItem(HIDE);
613 item.addActionListener(this);
615 // JAL-1264 hide all sequence-specific annotations of this type
616 final String label = aa[selectedRow].label;
617 if (selectedRow < aa.length)
619 if (aa[selectedRow].sequenceRef != null)
621 JMenuItem hideType = new JMenuItem();
622 String text = MessageManager.getString("label.hide_all") + " " + label;
623 hideType.setText(text);
624 hideType.addActionListener(new ActionListener()
627 public void actionPerformed(ActionEvent e)
629 for (AlignmentAnnotation ann : ap.av.getAlignment()
630 .getAlignmentAnnotation())
632 if (ann.sequenceRef != null && ann.label != null
633 && ann.label.equals(label))
644 item = new JMenuItem(DELETE);
645 item.addActionListener(this);
649 item = new JMenuItem(SHOWALL);
650 item.addActionListener(this);
653 item = new JMenuItem(OUTPUT_TEXT);
654 item.addActionListener(this);
656 // TODO: annotation object should be typed for autocalculated/derived
658 if (selectedRow < aa.length)
660 if (!aa[selectedRow].autoCalculated)
662 if (aa[selectedRow].graph == AlignmentAnnotation.NO_GRAPH)
664 // display formatting settings for this row.
666 // av and sequencegroup need to implement same interface for
667 item = new JCheckBoxMenuItem(TOGGLE_LABELSCALE,
668 aa[selectedRow].scaleColLabel);
669 item.addActionListener(this);
673 else if (label.indexOf("Consensus") > -1)
676 // av and sequencegroup need to implement same interface for
677 final JCheckBoxMenuItem cbmi = new JCheckBoxMenuItem(
678 MessageManager.getString("label.ignore_gaps_consensus"),
679 (aa[selectedRow].groupRef != null) ? aa[selectedRow].groupRef
680 .getIgnoreGapsConsensus() : ap.av
681 .getIgnoreGapsConsensus());
682 final AlignmentAnnotation aaa = aa[selectedRow];
683 cbmi.addActionListener(new ActionListener()
685 public void actionPerformed(ActionEvent e)
687 if (aaa.groupRef != null)
689 // TODO: pass on reference to ap so the view can be updated.
690 aaa.groupRef.setIgnoreGapsConsensus(cbmi.getState());
691 ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
695 ap.av.setIgnoreGapsConsensus(cbmi.getState(), ap);
700 // av and sequencegroup need to implement same interface for
701 if (aaa.groupRef != null)
703 final JCheckBoxMenuItem chist = new JCheckBoxMenuItem(
704 MessageManager.getString("label.show_group_histogram"),
705 aa[selectedRow].groupRef.isShowConsensusHistogram());
706 chist.addActionListener(new ActionListener()
708 public void actionPerformed(ActionEvent e)
710 // TODO: pass on reference
716 aaa.groupRef.setShowConsensusHistogram(chist.getState());
718 // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
722 final JCheckBoxMenuItem cprofl = new JCheckBoxMenuItem(
723 MessageManager.getString("label.show_group_logo"),
724 aa[selectedRow].groupRef.isShowSequenceLogo());
725 cprofl.addActionListener(new ActionListener()
727 public void actionPerformed(ActionEvent e)
729 // TODO: pass on reference
735 aaa.groupRef.setshowSequenceLogo(cprofl.getState());
737 // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
741 final JCheckBoxMenuItem cproflnorm = new JCheckBoxMenuItem(
742 MessageManager.getString("label.normalise_group_logo"),
743 aa[selectedRow].groupRef.isNormaliseSequenceLogo());
744 cproflnorm.addActionListener(new ActionListener()
746 public void actionPerformed(ActionEvent e)
749 // TODO: pass on reference
755 aaa.groupRef.setNormaliseSequenceLogo(cproflnorm.getState());
756 // automatically enable logo display if we're clicked
757 aaa.groupRef.setshowSequenceLogo(true);
759 // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
766 final JCheckBoxMenuItem chist = new JCheckBoxMenuItem(
767 MessageManager.getString("label.show_histogram"), av.isShowConsensusHistogram());
768 chist.addActionListener(new ActionListener()
770 public void actionPerformed(ActionEvent e)
772 // TODO: pass on reference
778 av.setShowConsensusHistogram(chist.getState());
779 ap.alignFrame.setMenusForViewport();
781 // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
785 final JCheckBoxMenuItem cprof = new JCheckBoxMenuItem(
786 MessageManager.getString("label.show_logo"), av.isShowSequenceLogo());
787 cprof.addActionListener(new ActionListener()
789 public void actionPerformed(ActionEvent e)
791 // TODO: pass on reference
797 av.setShowSequenceLogo(cprof.getState());
798 ap.alignFrame.setMenusForViewport();
800 // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
804 final JCheckBoxMenuItem cprofnorm = new JCheckBoxMenuItem(
805 MessageManager.getString("label.normalise_logo"), av.isNormaliseSequenceLogo());
806 cprofnorm.addActionListener(new ActionListener()
808 public void actionPerformed(ActionEvent e)
810 // TODO: pass on reference
816 av.setShowSequenceLogo(true);
817 av.setNormaliseSequenceLogo(cprofnorm.getState());
818 ap.alignFrame.setMenusForViewport();
820 // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
825 final JMenuItem consclipbrd = new JMenuItem(COPYCONS_SEQ);
826 consclipbrd.addActionListener(this);
827 pop.add(consclipbrd);
830 pop.show(this, evt.getX(), evt.getY());
834 * do a single sequence copy to jalview and the system clipboard
837 * sequence to be copied to clipboard
839 protected void copy_annotseqtoclipboard(SequenceI sq)
841 SequenceI[] seqs = new SequenceI[]
843 String[] omitHidden = null;
844 SequenceI[] dseqs = new SequenceI[]
845 { sq.getDatasetSequence() };
846 if (dseqs[0] == null)
848 dseqs[0] = new Sequence(sq);
849 dseqs[0].setSequence(jalview.analysis.AlignSeq.extractGaps(
850 jalview.util.Comparison.GapChars, sq.getSequenceAsString()));
852 sq.setDatasetSequence(dseqs[0]);
854 Alignment ds = new Alignment(dseqs);
855 if (av.hasHiddenColumns())
857 omitHidden = av.getColumnSelection().getVisibleSequenceStrings(0,
858 sq.getLength(), seqs);
861 String output = new FormatAdapter().formatSequences("Fasta", seqs,
864 Toolkit.getDefaultToolkit().getSystemClipboard()
865 .setContents(new StringSelection(output), Desktop.instance);
867 Vector hiddenColumns = null;
868 if (av.hasHiddenColumns())
870 hiddenColumns = new Vector();
871 for (int i = 0; i < av.getColumnSelection().getHiddenColumns().size(); i++)
873 int[] region = (int[]) av.getColumnSelection().getHiddenColumns()
876 hiddenColumns.addElement(new int[]
877 { region[0], region[1] });
881 Desktop.jalviewClipboard = new Object[]
882 { seqs, ds, // what is the dataset of a consensus sequence ? need to flag
883 // sequence as special.
893 public void paintComponent(Graphics g)
896 int width = getWidth();
899 width = ap.calculateIdWidth().width + 4;
902 Graphics2D g2 = (Graphics2D) g;
905 g2.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
906 RenderingHints.VALUE_ANTIALIAS_ON);
909 drawComponent(g2, true, width);
914 * Draw the full set of annotation Labels for the alignment at the given
918 * Graphics2D instance (needed for font scaling)
920 * Width for scaling labels
923 public void drawComponent(Graphics g, int width)
925 drawComponent(g, false, width);
928 private final boolean debugRedraw = false;
931 * Draw the full set of annotation Labels for the alignment at the given
935 * Graphics2D instance (needed for font scaling)
937 * - true indicates that only current visible area needs to be
940 * Width for scaling labels
942 public void drawComponent(Graphics g, boolean clip, int width)
944 if (av.getFont().getSize() < 10)
950 g.setFont(av.getFont());
953 FontMetrics fm = g.getFontMetrics(g.getFont());
954 g.setColor(Color.white);
955 g.fillRect(0, 0, getWidth(), getHeight());
957 g.translate(0, scrollOffset);
958 g.setColor(Color.black);
960 AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
961 int fontHeight = g.getFont().getSize();
966 Font baseFont = g.getFont();
967 FontMetrics baseMetrics = fm;
968 int ofontH = fontHeight;
971 int[] visr = (ap != null && ap.annotationPanel != null) ? ap.annotationPanel
972 .getVisibleVRange() : null;
973 if (clip && visr != null)
978 boolean visible = true, before = false, after = false;
981 hasHiddenRows = false;
983 for (int i = 0; i < aa.length; i++)
988 hasHiddenRows = true;
1001 System.out.println("before vis: " + i);
1005 // don't draw what isn't visible
1008 if (olY > visHeight)
1015 System.out.println("Scroll offset: " + sOffset
1016 + " after vis: " + i);
1020 // don't draw what isn't visible
1024 g.setColor(Color.black);
1026 offset = -aa[i].height / 2;
1030 offset += fm.getHeight() / 2;
1031 offset -= fm.getDescent();
1035 offset += fm.getDescent();
1038 x = width - fm.stringWidth(aa[i].label) - 3;
1040 if (aa[i].graphGroup > -1)
1043 // TODO: JAL-1291 revise rendering model so the graphGroup map is
1044 // computed efficiently for all visible labels
1045 for (int gg = 0; gg < aa.length; gg++)
1047 if (aa[gg].graphGroup == aa[i].graphGroup)
1052 if (groupSize * (fontHeight + 8) < aa[i].height)
1054 graphExtras = (aa[i].height - (groupSize * (fontHeight + 8))) / 2;
1058 // scale font to fit
1059 float h = aa[i].height / (float) groupSize, s;
1066 fontHeight = -8 + (int) h;
1067 s = ((float) fontHeight) / (float) ofontH;
1068 Font f = baseFont.deriveFont(AffineTransform
1069 .getScaleInstance(s, s));
1071 fm = g.getFontMetrics();
1072 graphExtras = (aa[i].height - (groupSize * (fontHeight + 8))) / 2;
1077 for (int gg = 0; gg < aa.length; gg++)
1079 if (aa[gg].graphGroup == aa[i].graphGroup)
1081 x = width - fm.stringWidth(aa[gg].label) - 3;
1082 g.drawString(aa[gg].label, x, y - graphExtras);
1084 if (aa[gg]._linecolour != null)
1087 g.setColor(aa[gg]._linecolour);
1088 g.drawLine(x, y - graphExtras + 3,
1089 x + fm.stringWidth(aa[gg].label), y - graphExtras
1093 g.setColor(Color.black);
1094 graphExtras += fontHeight + 8;
1098 g.setFont(baseFont);
1100 fontHeight = ofontH;
1104 g.drawString(aa[i].label, x, y + offset);
1111 g.drawImage(image, 2, 0 - scrollOffset, this);
1113 else if (dragEvent != null && aa != null)
1115 g.setColor(Color.lightGray);
1116 g.drawString(aa[selectedRow].label, dragEvent.getX(),
1117 dragEvent.getY() - scrollOffset);
1120 if (!av.wrapAlignment && ((aa == null) || (aa.length < 1)))
1122 g.drawString(MessageManager.getString("label.right_click"), 2, 8);
1123 g.drawString(MessageManager.getString("label.to_add_annotation"), 2,