src/jalview/gui/AnnotationLabels.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer
   3  * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  18  */
  19 package jalview.gui;
  20
  21 import java.util.*;
  22
  23 import java.awt.*;
  24 import java.awt.datatransfer.*;
  25 import java.awt.event.*;
  26 import java.awt.image.*;
  27 import javax.swing.*;
  28
  29 import jalview.datamodel.*;
  30 import jalview.io.*;
  31
  32 /**
  33  * DOCUMENT ME!
  34  *
  35  * @author $author$
  36  * @version $Revision$
  37  */
  38 public class AnnotationLabels
  39     extends JPanel implements MouseListener,
  40     MouseMotionListener, ActionListener
  41 {
  42   static String ADDNEW = "Add New Row";
  43   static String EDITNAME = "Edit Label/Description";
  44   static String HIDE = "Hide This Row";
  45   static String DELETE = "Delete This Row";
  46   static String SHOWALL = "Show All Hidden Rows";
  47   static String OUTPUT_TEXT = "Export Annotation";
  48   static String COPYCONS_SEQ = "Copy Consensus Sequence";
  49   boolean resizePanel = false;
  50   Image image;
  51   AlignmentPanel ap;
  52   AlignViewport av;
  53   boolean resizing = false;
  54   MouseEvent dragEvent;
  55   int oldY;
  56   int selectedRow;
  57   int scrollOffset = 0;
  58   Font font = new Font("Arial", Font.PLAIN, 11);
  59
  60   /**
  61    * Creates a new AnnotationLabels object.
  62    *
  63    * @param ap DOCUMENT ME!
  64    */
  65   public AnnotationLabels(AlignmentPanel ap)
  66   {
  67     this.ap = ap;
  68     av = ap.av;
  69     ToolTipManager.sharedInstance().registerComponent(this);
  70
  71     java.net.URL url = getClass().getResource("/images/idwidth.gif");
  72     Image temp = null;
  73
  74     if (url != null)
  75     {
  76       temp = java.awt.Toolkit.getDefaultToolkit().createImage(url);
  77     }
  78
  79     try
  80     {
  81       MediaTracker mt = new MediaTracker(this);
  82       mt.addImage(temp, 0);
  83       mt.waitForID(0);
  84     }
  85     catch (Exception ex)
  86     {
  87     }
  88
  89     BufferedImage bi = new BufferedImage(temp.getHeight(this),
  90                                          temp.getWidth(this),
  91                                          BufferedImage.TYPE_INT_RGB);
  92     Graphics2D g = (Graphics2D) bi.getGraphics();
  93     g.rotate(Math.toRadians(90));
  94     g.drawImage(temp, 0, -bi.getWidth(this), this);
  95     image = (Image) bi;
  96
  97     addMouseListener(this);
  98     addMouseMotionListener(this);
  99   }
 100
 101   public AnnotationLabels(AlignViewport av)
 102   {
 103     this.av = av;
 104   }
 105
 106   /**
 107    * DOCUMENT ME!
 108    *
 109    * @param y DOCUMENT ME!
 110    */
 111   public void setScrollOffset(int y)
 112   {
 113     scrollOffset = y;
 114     repaint();
 115   }
 116
 117   void getSelectedRow(int y)
 118   {
 119     int height = 0;
 120     AlignmentAnnotation[] aa = ap.av.alignment.getAlignmentAnnotation();
 121
 122     if (aa != null)
 123     {
 124       for (int i = 0; i < aa.length; i++)
 125       {
 126         if (!aa[i].visible)
 127         {
 128           continue;
 129         }
 130
 131         height += aa[i].height;
 132
 133         if (y < height)
 134         {
 135           selectedRow = i;
 136
 137           break;
 138         }
 139       }
 140     }
 141   }
 142
 143   /**
 144    * DOCUMENT ME!
 145    *
 146    * @param evt DOCUMENT ME!
 147    */
 148   public void actionPerformed(ActionEvent evt)
 149   {
 150     int dif = 0;
 151     AlignmentAnnotation[] aa = ap.av.alignment.getAlignmentAnnotation();
 152
 153     if (evt.getActionCommand().equals(ADDNEW))
 154     {
 155       AlignmentAnnotation newAnnotation = new AlignmentAnnotation(null,
 156           null,
 157           new Annotation[ap.av.alignment.getWidth()]);
 158
 159       if (!editLabelDescription(newAnnotation))
 160       {
 161         return;
 162       }
 163
 164       ap.av.alignment.addAnnotation(newAnnotation);
 165       ap.av.alignment.setAnnotationIndex(newAnnotation, 0);
 166       if (aa != null)
 167       {
 168         dif = aa[aa.length - 1].height;
 169       }
 170     }
 171     else if (evt.getActionCommand().equals(EDITNAME))
 172     {
 173       editLabelDescription(aa[selectedRow]);
 174       repaint();
 175     }
 176     else if (evt.getActionCommand().equals(HIDE))
 177     {
 178       aa[selectedRow].visible = false;
 179
 180       if (aa[selectedRow].label.equals("Quality"))
 181       {
 182         ap.av.quality = null;
 183       }
 184
 185       dif = aa[selectedRow].height * -1;
 186     }
 187     else if (evt.getActionCommand().equals(DELETE))
 188     {
 189       ap.av.alignment.deleteAnnotation(aa[selectedRow]);
 190       dif = aa[selectedRow].height * -1;
 191     }
 192     else if (evt.getActionCommand().equals(SHOWALL))
 193     {
 194       for (int i = 0; i < aa.length; i++)
 195       {
 196         if (!aa[i].visible)
 197         {
 198           dif += aa[i].height;
 199           aa[i].visible = true;
 200         }
 201       }
 202     }
 203     else if (evt.getActionCommand().equals(OUTPUT_TEXT))
 204     {
 205       new AnnotationExporter().exportAnnotations(
 206           ap,
 207           new AlignmentAnnotation[]
 208           {aa[selectedRow]},
 209           null
 210           );
 211     }
 212     else if (evt.getActionCommand().equals(COPYCONS_SEQ))
 213     {
 214       SequenceI cons = av.getConsensusSeq();
 215       if (cons != null)
 216       {
 217         copy_annotseqtoclipboard(cons);
 218       }
 219
 220     }
 221
 222     ap.annotationPanel.adjustPanelHeight();
 223     ap.annotationScroller.validate();
 224     ap.repaint();
 225   }
 226
 227   /**
 228    * DOCUMENT ME!
 229    *
 230    * @param e DOCUMENT ME!
 231    */
 232   boolean editLabelDescription(AlignmentAnnotation annotation)
 233   {
 234     EditNameDialog dialog = new EditNameDialog(annotation.label,
 235                                                annotation.description,
 236                                                "       Annotation Name ",
 237                                                "Annotation Description ",
 238                                                "Edit Annotation Name/Description");
 239
 240     if (!dialog.accept)
 241     {
 242       return false;
 243     }
 244
 245     annotation.label = dialog.getName();
 246
 247     String text = dialog.getDescription();
 248     if (text.length() == 0)
 249     {
 250       text = null;
 251     }
 252     annotation.description = text;
 253
 254     return true;
 255   }
 256
 257   /**
 258    * DOCUMENT ME!
 259    *
 260    * @param evt DOCUMENT ME!
 261    */
 262   public void mousePressed(MouseEvent evt)
 263   {
 264     getSelectedRow(evt.getY() - scrollOffset);
 265     oldY = evt.getY();
 266   }
 267
 268   /**
 269    * DOCUMENT ME!
 270    *
 271    * @param evt DOCUMENT ME!
 272    */
 273   public void mouseReleased(MouseEvent evt)
 274   {
 275     int start = selectedRow;
 276     getSelectedRow(evt.getY() - scrollOffset);
 277     int end = selectedRow;
 278
 279     if (start != end)
 280     {
 281       //Swap these annotations
 282       AlignmentAnnotation startAA = ap.av.alignment.getAlignmentAnnotation()[
 283           start];
 284       AlignmentAnnotation endAA = ap.av.alignment.getAlignmentAnnotation()[end];
 285
 286       ap.av.alignment.getAlignmentAnnotation()[end] = startAA;
 287       ap.av.alignment.getAlignmentAnnotation()[start] = endAA;
 288     }
 289
 290     resizePanel = false;
 291     dragEvent = null;
 292     repaint();
 293     ap.annotationPanel.repaint();
 294   }
 295
 296   /**
 297    * DOCUMENT ME!
 298    *
 299    * @param evt DOCUMENT ME!
 300    */
 301   public void mouseEntered(MouseEvent evt)
 302   {
 303     if (evt.getY() < 10)
 304     {
 305       resizePanel = true;
 306       repaint();
 307     }
 308   }
 309
 310   /**
 311    * DOCUMENT ME!
 312    *
 313    * @param evt DOCUMENT ME!
 314    */
 315   public void mouseExited(MouseEvent evt)
 316   {
 317     if (dragEvent == null)
 318     {
 319       resizePanel = false;
 320       repaint();
 321     }
 322   }
 323
 324   /**
 325    * DOCUMENT ME!
 326    *
 327    * @param evt DOCUMENT ME!
 328    */
 329   public void mouseDragged(MouseEvent evt)
 330   {
 331     dragEvent = evt;
 332
 333     if (resizePanel)
 334     {
 335       Dimension d = ap.annotationScroller.getPreferredSize();
 336       int dif = evt.getY() - oldY;
 337
 338       dif /= ap.av.charHeight;
 339       dif *= ap.av.charHeight;
 340
 341       if ( (d.height - dif) > 20)
 342       {
 343         ap.annotationScroller.setPreferredSize(new Dimension(d.width,
 344             d.height - dif));
 345         d = ap.annotationSpaceFillerHolder.getPreferredSize();
 346         ap.annotationSpaceFillerHolder.setPreferredSize(new Dimension(
 347             d.width, d.height - dif));
 348         ap.repaint();
 349       }
 350
 351       ap.addNotify();
 352     }
 353     else
 354     {
 355       repaint();
 356     }
 357   }
 358
 359   /**
 360    * DOCUMENT ME!
 361    *
 362    * @param evt DOCUMENT ME!
 363    */
 364   public void mouseMoved(MouseEvent evt)
 365   {
 366     resizePanel = evt.getY() < 10;
 367
 368     getSelectedRow(evt.getY() - scrollOffset);
 369
 370     if (selectedRow > -1
 371         && ap.av.alignment.getAlignmentAnnotation().length > selectedRow)
 372     {
 373       String desc = ap.av.alignment.
 374           getAlignmentAnnotation()[selectedRow].description;
 375
 376       if (desc != null && !desc.equals("New description"))
 377       {
 378         setToolTipText(ap.av.alignment.
 379                        getAlignmentAnnotation()[selectedRow].description);
 380       }
 381
 382     }
 383     repaint();
 384   }
 385
 386   /**
 387    * DOCUMENT ME!
 388    *
 389    * @param evt DOCUMENT ME!
 390    */
 391   public void mouseClicked(MouseEvent evt)
 392   {
 393     if (!SwingUtilities.isRightMouseButton(evt))
 394     {
 395       return;
 396     }
 397
 398     AlignmentAnnotation[] aa = ap.av.alignment.getAlignmentAnnotation();
 399
 400     if ( (aa == null) || (aa.length == 0))
 401     {
 402       JPopupMenu pop = new JPopupMenu("Annotations");
 403       JMenuItem item = new JMenuItem(ADDNEW);
 404       item.addActionListener(this);
 405       pop.add(item);
 406       pop.show(this, evt.getX(), evt.getY());
 407
 408       return;
 409     }
 410
 411     JPopupMenu pop = new JPopupMenu("Annotations");
 412     JMenuItem item = new JMenuItem(ADDNEW);
 413     item.addActionListener(this);
 414     pop.add(item);
 415     item = new JMenuItem(EDITNAME);
 416     item.addActionListener(this);
 417     pop.add(item);
 418     item = new JMenuItem(HIDE);
 419     item.addActionListener(this);
 420     pop.add(item);
 421     item = new JMenuItem(DELETE);
 422     item.addActionListener(this);
 423     pop.add(item);
 424     item = new JMenuItem(SHOWALL);
 425     item.addActionListener(this);
 426     pop.add(item);
 427     item = new JMenuItem(OUTPUT_TEXT);
 428     item.addActionListener(this);
 429     pop.add(item);
 430     // annotation object should be typed
 431     if (aa[selectedRow] == ap.av.consensus)
 432     {
 433       pop.addSeparator();
 434       final JCheckBoxMenuItem cbmi = new JCheckBoxMenuItem(
 435           "Ignore Gaps In Consensus",
 436           ap.av.getIgnoreGapsConsensus());
 437       cbmi.addActionListener(new ActionListener()
 438       {
 439         public void actionPerformed(ActionEvent e)
 440         {
 441           ap.av.setIgnoreGapsConsensus(cbmi.getState(), ap);
 442         }
 443       });
 444       pop.add(cbmi);
 445       final JMenuItem consclipbrd = new JMenuItem(COPYCONS_SEQ);
 446       consclipbrd.addActionListener(this);
 447       pop.add(consclipbrd);
 448     }
 449
 450     pop.show(this, evt.getX(), evt.getY());
 451   }
 452
 453   /**
 454    * do a single sequence copy to jalview and the system clipboard
 455    *
 456    * @param sq sequence to be copied to clipboard
 457    */
 458   protected void copy_annotseqtoclipboard(SequenceI sq)
 459   {
 460     SequenceI[] seqs = new SequenceI[]
 461         {
 462         sq};
 463     String[] omitHidden = null;
 464     SequenceI[] dseqs = new SequenceI[]
 465         {
 466         sq.getDatasetSequence()};
 467     if (dseqs[0] == null)
 468     {
 469       dseqs[0] = new Sequence(sq);
 470       dseqs[0].setSequence(
 471           jalview.analysis.AlignSeq.extractGaps(
 472               jalview.util.Comparison.GapChars,
 473               sq.getSequenceAsString()));
 474
 475       sq.setDatasetSequence(dseqs[0]);
 476     }
 477     Alignment ds = new Alignment(dseqs);
 478     if (av.hasHiddenColumns)
 479     {
 480       omitHidden = av.getColumnSelection().getVisibleSequenceStrings(0,
 481           sq.getLength(), seqs);
 482     }
 483
 484     String output = new FormatAdapter().formatSequences(
 485         "Fasta",
 486         seqs,
 487         omitHidden);
 488
 489     Toolkit.getDefaultToolkit().getSystemClipboard()
 490         .setContents(new StringSelection(output), Desktop.instance);
 491
 492     Vector hiddenColumns = null;
 493     if (av.hasHiddenColumns)
 494     {
 495       hiddenColumns = new Vector();
 496       for (int i = 0; i < av.getColumnSelection().getHiddenColumns().size(); i++)
 497       {
 498         int[] region = (int[])
 499             av.getColumnSelection().getHiddenColumns().elementAt(i);
 500
 501         hiddenColumns.addElement(new int[]
 502                                  {region[0],
 503                                  region[1]});
 504       }
 505     }
 506
 507     Desktop.jalviewClipboard = new Object[]
 508         {
 509         seqs,
 510         ds, // what is the dataset of a consensus sequence ? need to flag sequence as special.
 511         hiddenColumns};
 512   }
 513
 514   /**
 515    * DOCUMENT ME!
 516    *
 517    * @param g1 DOCUMENT ME!
 518    */
 519   public void paintComponent(Graphics g)
 520   {
 521
 522     int width = getWidth();
 523     if (width == 0)
 524     {
 525       width = ap.calculateIdWidth().width + 4;
 526     }
 527
 528     Graphics2D g2 = (Graphics2D) g;
 529     if (av.antiAlias)
 530     {
 531       g2.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
 532                           RenderingHints.VALUE_ANTIALIAS_ON);
 533     }
 534
 535     drawComponent(g2, width);
 536
 537   }
 538
 539   /**
 540    * DOCUMENT ME!
 541    *
 542    * @param g DOCUMENT ME!
 543    */
 544   public void drawComponent(Graphics g, int width)
 545   {
 546     if (av.getFont().getSize() < 10)
 547     {
 548       g.setFont(font);
 549     }
 550     else
 551     {
 552       g.setFont(av.getFont());
 553     }
 554
 555     FontMetrics fm = g.getFontMetrics(g.getFont());
 556     g.setColor(Color.white);
 557     g.fillRect(0, 0, getWidth(), getHeight());
 558
 559     g.translate(0, scrollOffset);
 560     g.setColor(Color.black);
 561
 562     AlignmentAnnotation[] aa = av.alignment.getAlignmentAnnotation();
 563     int fontHeight = g.getFont().getSize();
 564     int y = fontHeight;
 565     int x = 0;
 566     int graphExtras = 0;
 567
 568     if (aa != null)
 569     {
 570       for (int i = 0; i < aa.length; i++)
 571       {
 572         if (!aa[i].visible)
 573         {
 574           continue;
 575         }
 576
 577         x = width - fm.stringWidth(aa[i].label) - 3;
 578
 579         if (aa[i].graph > 0 && aa[i].graphHeight > 0)
 580         {
 581           graphExtras = y;
 582
 583           y += (aa[i].height / 3);
 584
 585           if (aa[i].graphGroup < 0)
 586           {
 587             graphExtras = y + fontHeight;
 588           }
 589         }
 590
 591         if (aa[i].graphGroup > -1)
 592         {
 593           int groupSize = 0;
 594           for (int gg = 0; gg < aa.length; gg++)
 595           {
 596             if (aa[gg].graphGroup == aa[i].graphGroup)
 597             {
 598               groupSize++;
 599             }
 600           }
 601
 602           if (groupSize * (fontHeight + 8) < aa[i].height)
 603           {
 604             graphExtras += (aa[i].height - (groupSize * (fontHeight + 8))) / 2;
 605           }
 606
 607           for (int gg = 0; gg < aa.length; gg++)
 608           {
 609             if (aa[gg].graphGroup == aa[i].graphGroup)
 610             {
 611               x = width - fm.stringWidth(aa[gg].label) - 3;
 612               g.drawString(aa[gg].label, x, graphExtras);
 613               if (aa[gg].annotations[0] != null)
 614               {
 615                 g.setColor(aa[gg].annotations[0].colour);
 616               }
 617
 618               g.drawLine(x, graphExtras + 3,
 619                          x + fm.stringWidth(aa[gg].label),
 620                          graphExtras + 3);
 621
 622               g.setColor(Color.black);
 623               graphExtras += fontHeight + 8;
 624             }
 625           }
 626         }
 627         else
 628         {
 629           g.drawString(aa[i].label, x, y);
 630         }
 631
 632         if (aa[i].graph > 0)
 633         {
 634           /*  if (aa[i].graphLines != null)
 635             {
 636               for (int gl = 0; gl < aa[i].graphLines.size(); gl++)
 637               {
 638                  x = width - fm.stringWidth(aa[i].getGraphLine(gl).label) - 3;
 639                 g.drawString(aa[i].getGraphLine(gl).label, x, graphExtras);
 640                 g.setColor(aa[i].getGraphLine(gl).colour);
 641                 Graphics2D g2 = (Graphics2D) g;
 642                 g2.setStroke(new BasicStroke(1,
 643                     BasicStroke.CAP_SQUARE,
 644                     BasicStroke.JOIN_ROUND, 3f,
 645                     new float[]
 646                     {5f, 3f}, 0f));
 647
 648                 graphExtras += 3;
 649
 650                 g.drawLine(x, graphExtras,
 651                            x+fm.stringWidth(aa[i].label),
 652                            graphExtras);
 653                 g2.setStroke(new BasicStroke());
 654               }
 655             }*/
 656           y += ( (2 * aa[i].height) / 3);
 657         }
 658         else
 659         {
 660           y += aa[i].height;
 661         }
 662       }
 663     }
 664
 665     if (resizePanel)
 666     {
 667       g.drawImage(image, 2, 0 - scrollOffset, this);
 668     }
 669     else if (dragEvent != null && aa != null)
 670     {
 671       g.setColor(Color.lightGray);
 672       g.drawString(aa[selectedRow].label, dragEvent.getX(),
 673                    dragEvent.getY() - scrollOffset);
 674     }
 675
 676     if ( (aa == null) || (aa.length < 1))
 677     {
 678       g.drawString("Right click", 2, 8);
 679       g.drawString("to add annotation", 2, 18);
 680     }
 681   }
 682 }