2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
3 * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
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 of the License, or (at your option) any later version.
11 * Jalview is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 * PURPOSE. See the GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
21 import java.awt.event.*;
22 import java.awt.image.*;
23 import java.util.Hashtable;
27 import jalview.analysis.AAFrequency;
28 import jalview.analysis.StructureFrequency;
29 import jalview.datamodel.*;
30 import jalview.renderer.AnnotationRenderer;
31 import jalview.renderer.AwtRenderPanelI;
39 public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
40 MouseListener, MouseMotionListener, ActionListener,
43 final String HELIX = "Helix";
45 final String SHEET = "Sheet";
48 * For RNA secondary structure "stems" aka helices
50 final String STEM = "RNA Helix";
52 final String LABEL = "Label";
54 final String REMOVE = "Remove Annotation";
56 final String COLOUR = "Colour";
58 public final Color HELIX_COLOUR = Color.red.darker();
60 public final Color SHEET_COLOUR = Color.green.darker().darker();
62 public final Color STEM_COLOUR = Color.blue.darker();
65 public AlignViewport av;
69 public int activeRow = -1;
71 public BufferedImage image;
73 public BufferedImage fadedImage;
77 public FontMetrics fm;
79 public int imgWidth = 0;
81 boolean fastPaint = false;
83 // Used For mouse Dragging and resizing graphs
84 int graphStretch = -1;
86 int graphStretchY = -1;
88 int min; // used by mouseDragged to see if user
90 int max; // used by mouseDragged to see if user
92 boolean mouseDragging = false;
101 public final AnnotationRenderer renderer;
104 * Creates a new AnnotationPanel object.
109 public AnnotationPanel(AlignmentPanel ap)
112 MAC = new jalview.util.Platform().isAMac();
114 ToolTipManager.sharedInstance().registerComponent(this);
115 ToolTipManager.sharedInstance().setInitialDelay(0);
116 ToolTipManager.sharedInstance().setDismissDelay(10000);
119 this.setLayout(null);
120 addMouseListener(this);
121 addMouseMotionListener(this);
122 ap.annotationScroller.getVerticalScrollBar()
123 .addAdjustmentListener(this);
124 renderer = new AnnotationRenderer();
127 public AnnotationPanel(AlignViewport av)
130 renderer = new AnnotationRenderer();
139 public void adjustmentValueChanged(AdjustmentEvent evt)
141 ap.alabels.setScrollOffset(-evt.getValue());
145 * Calculates the height of the annotation displayed in the annotation panel.
146 * Callers should normally call the ap.adjustAnnotationHeight method to ensure
147 * all annotation associated components are updated correctly.
150 public int adjustPanelHeight()
152 int height = calcPanelHeight();
153 this.setPreferredSize(new Dimension(1, height));
156 // revalidate only when the alignment panel is fully constructed
164 * calculate the height for visible annotation, revalidating bounds where
165 * necessary ABSTRACT GUI METHOD
167 * @return total height of annotation
169 public int calcPanelHeight()
171 // setHeight of panels
172 AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
177 for (int i = 0; i < aa.length; i++)
181 System.err.println("Null annotation row: ignoring.");
193 aa[i].height += av.charHeight;
203 aa[i].height += aa[i].graphHeight;
206 if (aa[i].height == 0)
211 height += aa[i].height;
228 public void actionPerformed(ActionEvent evt)
230 AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
235 Annotation[] anot = aa[activeRow].annotations;
237 if (anot.length < av.getColumnSelection().getMax())
239 Annotation[] temp = new Annotation[av.getColumnSelection().getMax() + 2];
240 System.arraycopy(anot, 0, temp, 0, anot.length);
242 aa[activeRow].annotations = anot;
245 if (evt.getActionCommand().equals(REMOVE))
247 for (int i = 0; i < av.getColumnSelection().size(); i++)
249 anot[av.getColumnSelection().columnAt(i)] = null;
252 else if (evt.getActionCommand().equals(LABEL))
254 String exMesg = collectAnnotVals(anot, av.getColumnSelection(), LABEL);
255 String label = JOptionPane.showInputDialog(this, "Enter label",
263 if ((label.length() > 0) && !aa[activeRow].hasText)
265 aa[activeRow].hasText = true;
268 for (int i = 0; i < av.getColumnSelection().size(); i++)
270 int index = av.getColumnSelection().columnAt(i);
272 if (!av.getColumnSelection().isVisible(index))
275 if (anot[index] == null)
277 anot[index] = new Annotation(label, "", ' ', 0); // TODO: verify that
284 anot[index].displayCharacter = label;
288 else if (evt.getActionCommand().equals(COLOUR))
290 Color col = JColorChooser.showDialog(this,
291 "Choose foreground colour", Color.black);
293 for (int i = 0; i < av.getColumnSelection().size(); i++)
295 int index = av.getColumnSelection().columnAt(i);
297 if (!av.getColumnSelection().isVisible(index))
300 if (anot[index] == null)
302 anot[index] = new Annotation("", "", ' ', 0);
305 anot[index].colour = col;
312 String symbol = "\u03B1";
314 if (evt.getActionCommand().equals(HELIX))
318 else if (evt.getActionCommand().equals(SHEET))
324 // Added by LML to color stems
325 else if (evt.getActionCommand().equals(STEM))
331 if (!aa[activeRow].hasIcons)
333 aa[activeRow].hasIcons = true;
336 String label = JOptionPane.showInputDialog(
337 "Enter a label for the structure?", symbol);
344 if ((label.length() > 0) && !aa[activeRow].hasText)
346 aa[activeRow].hasText = true;
349 for (int i = 0; i < av.getColumnSelection().size(); i++)
351 int index = av.getColumnSelection().columnAt(i);
353 if (!av.getColumnSelection().isVisible(index))
356 if (anot[index] == null)
358 anot[index] = new Annotation(label, "", type, 0);
361 anot[index].secondaryStructure = type;
362 anot[index].displayCharacter = label;
365 aa[activeRow].validateRangeAndDisplay();
373 private String collectAnnotVals(Annotation[] anot,
374 ColumnSelection columnSelection, String label2)
376 String collatedInput = "";
378 // TODO: refactor and save av.getColumnSelection for efficiency
379 for (int i = 0; i < columnSelection.size(); i++)
381 int index = columnSelection.columnAt(i);
382 // always check for current display state - just in case
383 if (!av.getColumnSelection().isVisible(index))
385 String tlabel = null;
386 if (anot[index] != null)
387 { // LML added stem code
388 if (label2.equals(HELIX) || label2.equals(SHEET)
389 || label2.equals(STEM) || label2.equals(LABEL))
391 tlabel = anot[index].description;
392 if (tlabel == null || tlabel.length() < 1)
394 if (label2.equals(HELIX) || label2.equals(SHEET)
395 || label2.equals(STEM))
397 tlabel = "" + anot[index].secondaryStructure;
401 tlabel = "" + anot[index].displayCharacter;
405 if (tlabel != null && !tlabel.equals(last))
407 if (last.length() > 0)
409 collatedInput += " ";
411 collatedInput += tlabel;
415 return collatedInput;
424 public void mousePressed(MouseEvent evt)
427 AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
436 for (int i = 0; i < aa.length; i++)
440 height += aa[i].height;
443 if (evt.getY() < height)
449 else if (aa[i].graph > 0)
453 graphStretchY = evt.getY();
460 if (SwingUtilities.isRightMouseButton(evt) && activeRow != -1)
462 if (av.getColumnSelection() == null)
467 JPopupMenu pop = new JPopupMenu("Structure type");
470 * Just display the needed structure options
472 if (av.getAlignment().isNucleotide() == true)
474 item = new JMenuItem(STEM);
475 item.addActionListener(this);
480 item = new JMenuItem(HELIX);
481 item.addActionListener(this);
483 item = new JMenuItem(SHEET);
484 item.addActionListener(this);
487 item = new JMenuItem(LABEL);
488 item.addActionListener(this);
490 item = new JMenuItem(COLOUR);
491 item.addActionListener(this);
493 item = new JMenuItem(REMOVE);
494 item.addActionListener(this);
496 pop.show(this, evt.getX(), evt.getY());
506 ap.scalePanel.mousePressed(evt);
516 public void mouseReleased(MouseEvent evt)
520 mouseDragging = false;
521 ap.scalePanel.mouseReleased(evt);
530 public void mouseEntered(MouseEvent evt)
532 ap.scalePanel.mouseEntered(evt);
541 public void mouseExited(MouseEvent evt)
543 ap.scalePanel.mouseExited(evt);
552 public void mouseDragged(MouseEvent evt)
554 if (graphStretch > -1)
556 av.getAlignment().getAlignmentAnnotation()[graphStretch].graphHeight += graphStretchY
558 if (av.getAlignment().getAlignmentAnnotation()[graphStretch].graphHeight < 0)
560 av.getAlignment().getAlignmentAnnotation()[graphStretch].graphHeight = 0;
562 graphStretchY = evt.getY();
564 ap.paintAlignment(true);
568 ap.scalePanel.mouseDragged(evt);
578 public void mouseMoved(MouseEvent evt)
580 AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
584 this.setToolTipText(null);
591 for (int i = 0; i < aa.length; i++)
595 height += aa[i].height;
598 if (evt.getY() < height)
608 this.setToolTipText(null);
612 int res = (evt.getX() / av.getCharWidth()) + av.getStartRes();
614 if (av.hasHiddenColumns())
616 res = av.getColumnSelection().adjustForHiddenColumns(res);
619 if (row > -1 && aa[row].annotations != null
620 && res < (int) aa[row].annotations.length)
622 if (aa[row].graphGroup > -1)
624 StringBuffer tip = new StringBuffer("<html>");
625 for (int gg = 0; gg < aa.length; gg++)
627 if (aa[gg].graphGroup == aa[row].graphGroup
628 && aa[gg].annotations[res] != null)
630 tip.append(aa[gg].label + " "
631 + aa[gg].annotations[res].description + "<br>");
634 if (tip.length() != 6)
636 tip.setLength(tip.length() - 4);
637 this.setToolTipText(tip.toString() + "</html>");
640 else if (aa[row].annotations[res] != null
641 && aa[row].annotations[res].description != null
642 && aa[row].annotations[res].description.length() > 0)
644 this.setToolTipText(aa[row].annotations[res].description);
648 // clear the tooltip.
649 this.setToolTipText(null);
652 if (aa[row].annotations[res] != null)
654 StringBuffer text = new StringBuffer("Sequence position "
657 if (aa[row].annotations[res].description != null)
659 text.append(" " + aa[row].annotations[res].description);
662 ap.alignFrame.statusBar.setText(text.toString());
667 this.setToolTipText(null);
677 public void mouseClicked(MouseEvent evt)
681 AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
682 AlignmentAnnotation anot = aa[activeRow];
684 if (anot.description.equals("secondary structure"))
686 // System.out.println(anot.description+" "+anot.getRNAStruc());
691 // TODO mouseClicked-content and drawCursor are quite experimental!
692 public void drawCursor(Graphics graphics, SequenceI seq, int res, int x1,
695 int pady = av.charHeight / 5;
697 graphics.setColor(Color.black);
698 graphics.fillRect(x1, y1, av.charWidth, av.charHeight);
700 if (av.validCharWidth)
702 graphics.setColor(Color.white);
704 char s = seq.getCharAt(res);
706 charOffset = (av.charWidth - fm.charWidth(s)) / 2;
707 graphics.drawString(String.valueOf(s), charOffset + x1,
708 (y1 + av.charHeight) - pady);
719 public void paintComponent(Graphics g)
721 g.setColor(Color.white);
722 g.fillRect(0, 0, getWidth(), getHeight());
726 if (fastPaint || (getVisibleRect().width != g.getClipBounds().width)
727 || (getVisibleRect().height != g.getClipBounds().height))
729 g.drawImage(image, 0, 0, this);
734 imgWidth = (av.endRes - av.startRes + 1) * av.charWidth;
737 if (image == null || imgWidth != image.getWidth()
738 || image.getHeight(this) != getHeight())
740 image = new BufferedImage(imgWidth, ap.annotationPanel.getHeight(),
741 BufferedImage.TYPE_INT_RGB);
742 gg = (Graphics2D) image.getGraphics();
746 gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
747 RenderingHints.VALUE_ANTIALIAS_ON);
750 gg.setFont(av.getFont());
751 fm = gg.getFontMetrics();
752 gg.setColor(Color.white);
753 gg.fillRect(0, 0, imgWidth, image.getHeight());
756 drawComponent(gg, av.startRes, av.endRes + 1);
757 g.drawImage(image, 0, 0, this);
761 * non-Thread safe repaint
764 * repaint with horizontal shift in alignment
766 public void fastPaint(int horizontal)
769 if ((horizontal == 0) || gg == null
770 || av.getAlignment().getAlignmentAnnotation() == null
771 || av.getAlignment().getAlignmentAnnotation().length < 1
772 || av.isCalcInProgress())
777 gg.copyArea(0, 0, imgWidth, getHeight(), -horizontal * av.charWidth, 0);
779 int sr = av.startRes;
780 int er = av.endRes + 1;
783 if (horizontal > 0) // scrollbar pulled right, image to the left
785 transX = (er - sr - horizontal) * av.charWidth;
786 sr = er - horizontal;
788 else if (horizontal < 0)
790 er = sr - horizontal;
793 gg.translate(transX, 0);
795 drawComponent(gg, sr, er);
797 gg.translate(-transX, 0);
814 public void drawComponent(Graphics g, int startRes, int endRes)
816 if (av.isCalcInProgress())
822 // We'll keep a record of the old image,
823 // and draw a faded image until the calculation
825 if (fadedImage == null || fadedImage.getWidth() != imgWidth
826 || fadedImage.getHeight() != image.getHeight())
828 fadedImage = new BufferedImage(imgWidth, image.getHeight(),
829 BufferedImage.TYPE_INT_RGB);
831 Graphics2D fadedG = (Graphics2D) fadedImage.getGraphics();
833 fadedG.setColor(Color.white);
834 fadedG.fillRect(0, 0, imgWidth, image.getHeight());
836 fadedG.setComposite(AlphaComposite.getInstance(
837 AlphaComposite.SRC_OVER, .3f));
838 fadedG.drawImage(image, 0, 0, this);
848 g.setColor(Color.white);
849 g.fillRect(0, 0, (endRes - startRes) * av.charWidth, getHeight());
851 g.setFont(av.getFont());
854 fm = g.getFontMetrics();
857 if ((av.getAlignment().getAlignmentAnnotation() == null)
858 || (av.getAlignment().getAlignmentAnnotation().length < 1))
860 g.setColor(Color.white);
861 g.fillRect(0, 0, getWidth(), getHeight());
862 g.setColor(Color.black);
863 if (av.validCharWidth)
865 g.drawString("Alignment has no annotations", 20, 15);
870 renderer.drawComponent(this, av, g, activeRow, startRes, endRes);
874 public FontMetrics getFontMetrics()
880 public Image getFadedImage()
886 public int getFadedImageWidth()