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.analysis.AlignmentUtils;
24 import jalview.datamodel.AlignmentAnnotation;
25 import jalview.datamodel.Annotation;
26 import jalview.datamodel.SequenceGroup;
27 import jalview.datamodel.SequenceI;
28 import jalview.util.MessageManager;
29 import jalview.util.ParseHtmlBodyAndLinks;
31 import java.awt.Checkbox;
32 import java.awt.CheckboxMenuItem;
33 import java.awt.Color;
34 import java.awt.Dimension;
35 import java.awt.FlowLayout;
36 import java.awt.FontMetrics;
37 import java.awt.Frame;
38 import java.awt.Graphics;
39 import java.awt.Image;
40 import java.awt.MenuItem;
41 import java.awt.Panel;
42 import java.awt.PopupMenu;
43 import java.awt.event.ActionEvent;
44 import java.awt.event.ActionListener;
45 import java.awt.event.InputEvent;
46 import java.awt.event.ItemEvent;
47 import java.awt.event.ItemListener;
48 import java.awt.event.MouseEvent;
49 import java.awt.event.MouseListener;
50 import java.awt.event.MouseMotionListener;
51 import java.util.Arrays;
52 import java.util.Collections;
53 import java.util.Vector;
55 public class AnnotationLabels extends Panel implements ActionListener,
56 MouseListener, MouseMotionListener
60 boolean active = false;
66 boolean resizing = false;
70 static String ADDNEW = "Add New Row";
72 static String EDITNAME = "Edit Label/Description";
74 static String HIDE = "Hide This Row";
76 static String SHOWALL = "Show All Hidden Rows";
78 static String OUTPUT_TEXT = "Show Values In Textbox";
80 static String COPYCONS_SEQ = "Copy Consensus Sequence";
88 private boolean hasHiddenRows;
90 public AnnotationLabels(AlignmentPanel ap)
97 * this retrieves the adjustable height glyph from resources. we don't use
98 * it at the moment. java.net.URL url =
99 * getClass().getResource("/images/idwidth.gif"); Image temp = null;
101 * if (url != null) { temp =
102 * java.awt.Toolkit.getDefaultToolkit().createImage(url); }
104 * try { MediaTracker mt = new MediaTracker(this); mt.addImage(temp, 0);
105 * mt.waitForID(0); } catch (Exception ex) { }
107 * BufferedImage bi = new BufferedImage(temp.getHeight(this),
108 * temp.getWidth(this), BufferedImage.TYPE_INT_RGB); Graphics2D g =
109 * (Graphics2D) bi.getGraphics(); g.rotate(Math.toRadians(90));
110 * g.drawImage(temp, 0, -bi.getWidth(this), this); image = (Image) bi;
112 addMouseListener(this);
113 addMouseMotionListener(this);
116 public AnnotationLabels(AlignViewport av)
121 public void setScrollOffset(int y, boolean repaint)
133 * @return -2 if no rows are visible at all, -1 if no visible rows were
136 int getSelectedRow(int y)
139 AlignmentAnnotation[] aa = ap.av.getAlignment()
140 .getAlignmentAnnotation();
147 for (int i = 0; i < aa.length; i++)
154 height += aa[i].height;
166 public void actionPerformed(ActionEvent evt)
168 AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
170 if (evt.getActionCommand().equals(ADDNEW))
172 AlignmentAnnotation newAnnotation = new AlignmentAnnotation("", null,
173 new Annotation[ap.av.getAlignment().getWidth()]);
175 if (!editLabelDescription(newAnnotation))
180 ap.av.getAlignment().addAnnotation(newAnnotation);
181 ap.av.getAlignment().setAnnotationIndex(newAnnotation, 0);
183 else if (evt.getActionCommand().equals(EDITNAME))
185 editLabelDescription(aa[selectedRow]);
187 else if (evt.getActionCommand().equals(HIDE))
189 aa[selectedRow].visible = false;
191 else if (evt.getActionCommand().equals(SHOWALL))
193 for (int i = 0; i < aa.length; i++)
195 aa[i].visible = (aa[i].annotations == null) ? false : true;
198 else if (evt.getActionCommand().equals(OUTPUT_TEXT))
200 CutAndPasteTransfer cap = new CutAndPasteTransfer(false,
202 Frame frame = new Frame();
204 jalview.bin.JalviewLite.addFrame(frame, ap.alignFrame.getTitle()
205 + " - " + aa[selectedRow].label, 500, 100);
206 cap.setText(aa[selectedRow].toString());
208 else if (evt.getActionCommand().equals(COPYCONS_SEQ))
210 SequenceI cons = av.getConsensusSeq();
213 copy_annotseqtoclipboard(cons);
221 * Adjust size and repaint
223 protected void refresh()
225 ap.annotationPanel.adjustPanelHeight();
226 setSize(getSize().width, ap.annotationPanel.getSize().height);
228 ap.paintAlignment(true);
231 boolean editLabelDescription(AlignmentAnnotation annotation)
233 Checkbox padGaps = new Checkbox("Fill Empty Gaps With \""
234 + ap.av.getGapCharacter() + "\"", annotation.padGaps);
236 EditNameDialog dialog = new EditNameDialog(annotation.label,
237 annotation.description, " Annotation Label",
238 "Annotation Description", ap.alignFrame,
239 "Edit Annotation Name / Description", 500, 180, false);
241 Panel empty = new Panel(new FlowLayout());
246 dialog.setVisible(true);
250 annotation.label = dialog.getName();
251 annotation.description = dialog.getDescription();
252 annotation.setPadGaps(padGaps.getState(), av.getGapCharacter());
263 boolean resizePanel = false;
266 public void mouseMoved(MouseEvent evt)
268 resizePanel = evt.getY() < 10 && evt.getX() < 14;
269 int row = getSelectedRow(evt.getY() + scrollOffset);
273 ParseHtmlBodyAndLinks phb = new ParseHtmlBodyAndLinks(
274 av.getAlignment().getAlignmentAnnotation()[row]
275 .getDescription(true),
279 tooltip = new Tooltip(phb.getNonHtmlContent(), this);
283 tooltip.setTip(phb.getNonHtmlContent());
286 else if (tooltip != null)
293 * curent drag position
295 MouseEvent dragEvent = null;
298 * flag to indicate drag events should be ignored
300 private boolean dragCancelled = false;
303 * clear any drag events in progress
305 public void cancelDrag()
308 dragCancelled = true;
312 public void mouseDragged(MouseEvent evt)
323 Dimension d = ap.annotationPanelHolder.getSize(), e = ap.annotationSpaceFillerHolder
324 .getSize(), f = ap.seqPanelHolder.getSize();
325 int dif = evt.getY() - oldY;
327 dif /= ap.av.getCharHeight();
328 dif *= ap.av.getCharHeight();
330 if ((d.height - dif) > 20 && (f.height + dif) > 20)
332 ap.annotationPanel.setSize(d.width, d.height - dif);
333 setSize(new Dimension(e.width, d.height - dif));
334 ap.annotationSpaceFillerHolder.setSize(new Dimension(e.width,
336 ap.annotationPanelHolder.setSize(new Dimension(d.width, d.height
338 ap.apvscroll.setValues(ap.apvscroll.getValue(), d.height - dif, 0,
339 av.calcPanelHeight());
341 ap.seqPanelHolder.setPreferredSize(f);
342 ap.setScrollValues(av.getRanges().getStartRes(), av.getRanges()
345 // ap.paintAlignment(true);
353 if ((diff = 6 - evt.getY()) > 0)
356 ap.apvscroll.setValue(ap.apvscroll.getValue() - diff);
357 ap.adjustmentValueChanged(null);
360 else if ((0 < (diff = 6
361 - ap.annotationSpaceFillerHolder.getSize().height
365 ap.apvscroll.setValue(ap.apvscroll.getValue() + diff);
366 ap.adjustmentValueChanged(null);
373 public void mouseClicked(MouseEvent evt)
378 public void mouseReleased(MouseEvent evt)
380 if (!resizePanel && !dragCancelled)
382 int start = selectedRow;
384 int end = getSelectedRow(evt.getY() + scrollOffset);
386 if (start > -1 && start != end)
388 // Swap these annotations
389 AlignmentAnnotation startAA = ap.av.getAlignment()
390 .getAlignmentAnnotation()[start];
393 end = ap.av.getAlignment().getAlignmentAnnotation().length - 1;
395 AlignmentAnnotation endAA = ap.av.getAlignment()
396 .getAlignmentAnnotation()[end];
398 ap.av.getAlignment().getAlignmentAnnotation()[end] = startAA;
399 ap.av.getAlignment().getAlignmentAnnotation()[start] = endAA;
404 dragCancelled = false;
406 ap.annotationPanel.repaint();
410 public void mouseEntered(MouseEvent evt)
412 if (evt.getY() < 10 && evt.getX() < 14)
420 public void mouseExited(MouseEvent evt)
422 dragCancelled = false;
424 if (dragEvent == null)
439 public void mousePressed(MouseEvent evt)
446 dragCancelled = false;
447 // todo: move below to mouseClicked ?
448 selectedRow = getSelectedRow(evt.getY() + scrollOffset);
450 AlignmentAnnotation[] aa = ap.av.getAlignment()
451 .getAlignmentAnnotation();
453 // DETECT RIGHT MOUSE BUTTON IN AWT
454 if ((evt.getModifiers() & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
457 PopupMenu popup = new PopupMenu(
458 MessageManager.getString("label.annotations"));
460 MenuItem item = new MenuItem(ADDNEW);
461 item.addActionListener(this);
465 // this never happens at moment: - see comment on JAL-563
468 item = new MenuItem(SHOWALL);
469 item.addActionListener(this);
473 popup.show(this, evt.getX(), evt.getY());
476 // add the rest if there are actually rows to show
477 item = new MenuItem(EDITNAME);
478 item.addActionListener(this);
480 item = new MenuItem(HIDE);
481 item.addActionListener(this);
487 if (selectedRow < aa.length)
489 if (aa[selectedRow].sequenceRef != null)
491 final String label = aa[selectedRow].label;
492 MenuItem hideType = new MenuItem(
493 MessageManager.getString("label.hide_all") + " " + label);
494 hideType.addActionListener(new ActionListener()
497 public void actionPerformed(ActionEvent e)
499 AlignmentUtils.showOrHideSequenceAnnotations(
500 ap.av.getAlignment(), Collections.singleton(label),
511 item = new MenuItem(SHOWALL);
512 item.addActionListener(this);
516 item = new MenuItem(OUTPUT_TEXT);
517 item.addActionListener(this);
519 if (selectedRow < aa.length)
521 if (aa[selectedRow].autoCalculated)
523 if (aa[selectedRow].label.indexOf("Consensus") > -1)
525 popup.addSeparator();
526 final CheckboxMenuItem cbmi = new CheckboxMenuItem(
527 MessageManager.getString("label.ignore_gaps_consensus"),
528 (aa[selectedRow].groupRef != null) ? aa[selectedRow].groupRef
529 .getIgnoreGapsConsensus() : ap.av
530 .isIgnoreGapsConsensus());
531 final AlignmentAnnotation aaa = aa[selectedRow];
532 cbmi.addItemListener(new ItemListener()
535 public void itemStateChanged(ItemEvent e)
537 if (aaa.groupRef != null)
539 // TODO: pass on reference to ap so the view can be updated.
540 aaa.groupRef.setIgnoreGapsConsensus(cbmi.getState());
544 ap.av.setIgnoreGapsConsensus(cbmi.getState(), ap);
546 ap.paintAlignment(true);
550 if (aaa.groupRef != null)
552 final CheckboxMenuItem chist = new CheckboxMenuItem(
554 .getString("label.show_group_histogram"),
555 aa[selectedRow].groupRef.isShowConsensusHistogram());
556 chist.addItemListener(new ItemListener()
559 public void itemStateChanged(ItemEvent e)
561 // TODO: pass on reference
567 aaa.groupRef.setShowConsensusHistogram(chist.getState());
569 // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
573 final CheckboxMenuItem cprofl = new CheckboxMenuItem(
574 MessageManager.getString("label.show_group_logo"),
575 aa[selectedRow].groupRef.isShowSequenceLogo());
576 cprofl.addItemListener(new ItemListener()
579 public void itemStateChanged(ItemEvent e)
581 // TODO: pass on reference
587 aaa.groupRef.setshowSequenceLogo(cprofl.getState());
589 // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
594 final CheckboxMenuItem cprofn = new CheckboxMenuItem(
596 .getString("label.normalise_group_logo"),
597 aa[selectedRow].groupRef.isNormaliseSequenceLogo());
598 cprofn.addItemListener(new ItemListener()
601 public void itemStateChanged(ItemEvent e)
603 // TODO: pass on reference
609 aaa.groupRef.setshowSequenceLogo(true);
610 aaa.groupRef.setNormaliseSequenceLogo(cprofn.getState());
612 // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
619 final CheckboxMenuItem chist = new CheckboxMenuItem(
620 MessageManager.getString("label.show_histogram"),
621 av.isShowConsensusHistogram());
622 chist.addItemListener(new ItemListener()
625 public void itemStateChanged(ItemEvent e)
627 // TODO: pass on reference
633 av.setShowConsensusHistogram(chist.getState());
634 ap.alignFrame.showConsensusHistogram.setState(chist
635 .getState()); // TODO: implement
636 // ap.updateGUI()/alignFrame.updateGUI
639 // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
643 final CheckboxMenuItem cprof = new CheckboxMenuItem(
644 MessageManager.getString("label.show_logo"),
645 av.isShowSequenceLogo());
646 cprof.addItemListener(new ItemListener()
649 public void itemStateChanged(ItemEvent e)
651 // TODO: pass on reference
657 av.setShowSequenceLogo(cprof.getState());
658 ap.alignFrame.showSequenceLogo.setState(cprof.getState()); // TODO:
660 // ap.updateGUI()/alignFrame.updateGUI
664 // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
668 final CheckboxMenuItem cprofn = new CheckboxMenuItem(
669 MessageManager.getString("label.normalise_logo"),
670 av.isNormaliseSequenceLogo());
671 cprofn.addItemListener(new ItemListener()
674 public void itemStateChanged(ItemEvent e)
676 // TODO: pass on reference
682 av.setShowSequenceLogo(true);
683 ap.alignFrame.normSequenceLogo.setState(cprofn.getState()); // TODO:
685 // ap.updateGUI()/alignFrame.updateGUI
688 av.setNormaliseSequenceLogo(cprofn.getState());
690 // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
696 item = new MenuItem(COPYCONS_SEQ);
697 item.addActionListener(this);
702 popup.show(this, evt.getX(), evt.getY());
707 if (selectedRow > -1 && selectedRow < aa.length)
709 if (aa[selectedRow].groupRef != null)
711 if (evt.getClickCount() >= 2)
713 // todo: make the ap scroll to the selection - not necessary, first
714 // click highlights/scrolls, second selects
715 ap.seqPanel.ap.idPanel.highlightSearchResults(null);
717 SequenceGroup sg = ap.av.getSelectionGroup();
719 || sg == aa[selectedRow].groupRef
720 || !(jalview.util.Platform.isControlDown(evt) || evt
723 if (jalview.util.Platform.isControlDown(evt)
724 || evt.isShiftDown())
726 // clone a new selection group from the associated group
727 ap.av.setSelectionGroup(new SequenceGroup(
728 aa[selectedRow].groupRef));
732 // set selection to the associated group so it can be edited
733 ap.av.setSelectionGroup(aa[selectedRow].groupRef);
738 // modify current selection with associated group
739 int remainToAdd = aa[selectedRow].groupRef.getSize();
740 for (SequenceI sgs : aa[selectedRow].groupRef.getSequences())
742 if (jalview.util.Platform.isControlDown(evt))
744 sg.addOrRemove(sgs, --remainToAdd == 0);
748 // notionally, we should also add intermediate sequences from
749 // last added sequence ?
750 sg.addSequence(sgs, --remainToAdd == 0);
754 ap.paintAlignment(false);
755 PaintRefresher.Refresh(ap, ap.av.getSequenceSetId());
756 ap.av.sendSelection();
760 ap.seqPanel.ap.idPanel
761 .highlightSearchResults(aa[selectedRow].groupRef
762 .getSequences(null));
766 else if (aa[selectedRow].sequenceRef != null)
768 if (evt.getClickCount() == 1)
770 ap.seqPanel.ap.idPanel
771 .highlightSearchResults(Arrays
772 .asList(new SequenceI[] { aa[selectedRow].sequenceRef }));
774 else if (evt.getClickCount() >= 2)
776 ap.seqPanel.ap.idPanel.highlightSearchResults(null);
777 SequenceGroup sg = ap.av.getSelectionGroup();
780 // we make a copy rather than edit the current selection if no
782 // see Enhancement JAL-1557
783 if (!(jalview.util.Platform.isControlDown(evt) || evt
786 sg = new SequenceGroup(sg);
788 sg.addSequence(aa[selectedRow].sequenceRef, false);
792 if (jalview.util.Platform.isControlDown(evt))
794 sg.addOrRemove(aa[selectedRow].sequenceRef, true);
798 // notionally, we should also add intermediate sequences from
799 // last added sequence ?
800 sg.addSequence(aa[selectedRow].sequenceRef, true);
806 sg = new SequenceGroup();
808 sg.setEndRes(ap.av.getAlignment().getWidth() - 1);
809 sg.addSequence(aa[selectedRow].sequenceRef, false);
811 ap.av.setSelectionGroup(sg);
812 ap.paintAlignment(false);
813 PaintRefresher.Refresh(ap, ap.av.getSequenceSetId());
814 ap.av.sendSelection();
829 protected void copy_annotseqtoclipboard(SequenceI sq)
831 if (sq == null || sq.getLength() < 1)
835 jalview.appletgui.AlignFrame.copiedSequences = new StringBuffer();
836 jalview.appletgui.AlignFrame.copiedSequences.append(sq.getName() + "\t"
837 + sq.getStart() + "\t" + sq.getEnd() + "\t"
838 + sq.getSequenceAsString() + "\n");
839 if (av.hasHiddenColumns())
841 jalview.appletgui.AlignFrame.copiedHiddenColumns = new Vector();
842 for (int[] region : av.getColumnSelection().getHiddenColumns())
844 jalview.appletgui.AlignFrame.copiedHiddenColumns
845 .addElement(new int[] { region[0], region[1] });
851 public void update(Graphics g)
857 public void paint(Graphics g)
859 int w = getSize().width;
860 int h = getSize().height;
861 if (image == null || w != image.getWidth(this)
862 || h != image.getHeight(this))
864 image = createImage(w, ap.annotationPanel.getSize().height);
867 drawComponent(image.getGraphics(), w);
868 g.drawImage(image, 0, 0, this);
871 public void drawComponent(Graphics g, int width)
873 g.setFont(av.getFont());
874 FontMetrics fm = g.getFontMetrics(av.getFont());
875 g.setColor(Color.white);
876 g.fillRect(0, 0, getSize().width, getSize().height);
878 g.translate(0, -scrollOffset);
879 g.setColor(Color.black);
881 AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
882 int y = 0, fy = g.getFont().getSize();
887 hasHiddenRows = false;
888 for (int i = 0; i < aa.length; i++)
892 hasHiddenRows = true;
896 x = width - fm.stringWidth(aa[i].label) - 3;
899 offset = -(aa[i].height - fy) / 2;
901 g.drawString(aa[i].label, x, y + offset);
904 g.translate(0, +scrollOffset);
907 g.setColor(Color.red);
909 g.drawLine(2, 8, 5, 2);
910 g.drawLine(5, 2, 8, 8);
912 else if (!dragCancelled && dragEvent != null && aa != null)
914 g.setColor(Color.lightGray);
915 g.drawString(aa[selectedRow].label, dragEvent.getX(),
919 if (!av.getWrapAlignment() && ((aa == null) || (aa.length < 1)))
921 g.setColor(Color.black);
922 g.drawString(MessageManager.getString("label.right_click"), 2, 8);
923 g.drawString(MessageManager.getString("label.to_add_annotation"), 2,