JAL-1153 new runtime property set to first non-null annotation element colour
[jalview.git] / src / jalview / gui / AnnotationLabels.java
index 18bda61..6d32c04 100755 (executable)
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
  * 
  * This file is part of Jalview.
  * 
@@ -18,6 +18,7 @@
 package jalview.gui;
 
 import java.util.*;
+import java.util.regex.Pattern;
 
 import java.awt.*;
 import java.awt.datatransfer.*;
@@ -73,6 +74,8 @@ public class AnnotationLabels extends JPanel implements MouseListener,
 
   Font font = new Font("Arial", Font.PLAIN, 11);
 
+  private boolean hasHiddenRows;
+
   /**
    * Creates a new AnnotationLabels object.
    * 
@@ -102,8 +105,8 @@ public class AnnotationLabels extends JPanel implements MouseListener,
     {
     }
 
-    BufferedImage bi = new BufferedImage(temp.getHeight(this), temp
-            .getWidth(this), BufferedImage.TYPE_INT_RGB);
+    BufferedImage bi = new BufferedImage(temp.getHeight(this),
+            temp.getWidth(this), BufferedImage.TYPE_INT_RGB);
     Graphics2D g = (Graphics2D) bi.getGraphics();
     g.rotate(Math.toRadians(90));
     g.drawImage(temp, 0, -bi.getWidth(this), this);
@@ -130,15 +133,23 @@ public class AnnotationLabels extends JPanel implements MouseListener,
     repaint();
   }
 
+  /**
+   * sets selectedRow to -2 if no annotation preset, -1 if no visible row is at
+   * y
+   * 
+   * @param y
+   *          coordinate position to search for a row
+   */
   void getSelectedRow(int y)
   {
     int height = 0;
-    AlignmentAnnotation[] aa = ap.av.alignment.getAlignmentAnnotation();
-
+    AlignmentAnnotation[] aa = ap.av.getAlignment().getAlignmentAnnotation();
+    selectedRow = -2;
     if (aa != null)
     {
       for (int i = 0; i < aa.length; i++)
       {
+        selectedRow = -1;
         if (!aa[i].visible)
         {
           continue;
@@ -164,20 +175,20 @@ public class AnnotationLabels extends JPanel implements MouseListener,
    */
   public void actionPerformed(ActionEvent evt)
   {
-    AlignmentAnnotation[] aa = ap.av.alignment.getAlignmentAnnotation();
+    AlignmentAnnotation[] aa = ap.av.getAlignment().getAlignmentAnnotation();
 
     if (evt.getActionCommand().equals(ADDNEW))
     {
       AlignmentAnnotation newAnnotation = new AlignmentAnnotation(null,
-              null, new Annotation[ap.av.alignment.getWidth()]);
+              null, new Annotation[ap.av.getAlignment().getWidth()]);
 
       if (!editLabelDescription(newAnnotation))
       {
         return;
       }
 
-      ap.av.alignment.addAnnotation(newAnnotation);
-      ap.av.alignment.setAnnotationIndex(newAnnotation, 0);
+      ap.av.getAlignment().addAnnotation(newAnnotation);
+      ap.av.getAlignment().setAnnotationIndex(newAnnotation, 0);
     }
     else if (evt.getActionCommand().equals(EDITNAME))
     {
@@ -187,15 +198,10 @@ public class AnnotationLabels extends JPanel implements MouseListener,
     else if (evt.getActionCommand().equals(HIDE))
     {
       aa[selectedRow].visible = false;
-
-      if (aa[selectedRow].label.equals("Quality"))
-      {
-        ap.av.quality = null;
-      }
     }
     else if (evt.getActionCommand().equals(DELETE))
     {
-      ap.av.alignment.deleteAnnotation(aa[selectedRow]);
+      ap.av.getAlignment().deleteAnnotation(aa[selectedRow]);
     }
     else if (evt.getActionCommand().equals(SHOWALL))
     {
@@ -235,9 +241,11 @@ public class AnnotationLabels extends JPanel implements MouseListener,
       aa[selectedRow].scaleColLabel = !aa[selectedRow].scaleColLabel;
     }
 
-    ap.annotationPanel.adjustPanelHeight();
-    ap.annotationScroller.validate();
-    ap.paintAlignment(true);
+    ap.validateAnnotationDimensions(false);
+    ap.addNotify();
+    ap.repaint();
+    //validate();
+    //ap.paintAlignment(true);
   }
 
   /**
@@ -250,7 +258,8 @@ public class AnnotationLabels extends JPanel implements MouseListener,
   {
     EditNameDialog dialog = new EditNameDialog(annotation.label,
             annotation.description, "       Annotation Name ",
-            "Annotation Description ", "Edit Annotation Name/Description");
+            "Annotation Description ", "Edit Annotation Name/Description",
+            ap.alignFrame);
 
     if (!dialog.accept)
     {
@@ -296,12 +305,16 @@ public class AnnotationLabels extends JPanel implements MouseListener,
     if (start != end)
     {
       // Swap these annotations
-      AlignmentAnnotation startAA = ap.av.alignment
+      AlignmentAnnotation startAA = ap.av.getAlignment()
               .getAlignmentAnnotation()[start];
-      AlignmentAnnotation endAA = ap.av.alignment.getAlignmentAnnotation()[end];
+      if (end == -1)
+      {
+        end = ap.av.getAlignment().getAlignmentAnnotation().length - 1;
+      }
+      AlignmentAnnotation endAA = ap.av.getAlignment().getAlignmentAnnotation()[end];
 
-      ap.av.alignment.getAlignmentAnnotation()[end] = startAA;
-      ap.av.alignment.getAlignmentAnnotation()[start] = endAA;
+      ap.av.getAlignment().getAlignmentAnnotation()[end] = startAA;
+      ap.av.getAlignment().getAlignmentAnnotation()[start] = endAA;
     }
 
     resizePanel = false;
@@ -389,25 +402,46 @@ public class AnnotationLabels extends JPanel implements MouseListener,
     getSelectedRow(evt.getY() - scrollOffset);
 
     if (selectedRow > -1
-            && ap.av.alignment.getAlignmentAnnotation().length > selectedRow)
+            && ap.av.getAlignment().getAlignmentAnnotation().length > selectedRow)
     {
-      AlignmentAnnotation aa = ap.av.alignment.getAlignmentAnnotation()[selectedRow];
-
-      StringBuffer desc = new StringBuffer("<html>");
-
+      AlignmentAnnotation aa = ap.av.getAlignment().getAlignmentAnnotation()[selectedRow];
+      
+      StringBuffer desc = new StringBuffer();
       if (aa.description != null
               && !aa.description.equals("New description"))
       {
-        desc.append(aa.getDescription(true));
-        if (aa.hasScore)
-          desc.append("<br>");
+        // TODO: we could refactor and merge this code with the code in jalview.gui.SeqPanel.mouseMoved(..) that formats sequence feature tooltips
+        desc.append(aa.getDescription(true).trim());
+        // check to see if the description is an html fragment.
+        if (desc.length()<6 || (desc.substring(0,6).toLowerCase().indexOf("<html>")<0))
+        {
+          // clean the description ready for embedding in html
+          desc = new StringBuffer(Pattern.compile("<").matcher(desc).replaceAll("&lt;"));        
+          desc.insert(0, "<html>");
+        } else {
+               // remove terminating html if any
+               int i=desc.substring(desc.length()-7).toLowerCase().lastIndexOf("</html>");
+               if (i>-1) {
+                 desc.setLength(desc.length()-7+i);
+               }
+        }
+        if (aa.hasScore())
+        {
+          desc.append("<br/>");
+        }
+        
+        
+      } else {
+        // begin the tooltip's html fragment
+        desc.append("<html>");
       }
       if (aa.hasScore())
       {
-        desc.append("Score: " + aa.score);
+        // TODO: limit precision of score to avoid noise from imprecise doubles (64.7 becomes 64.7+/some tiny value).
+        desc.append(" Score: " + aa.score);
       }
 
-      if (desc.length() != 6)
+      if (desc.length() > 6)
       {
         desc.append("</html>");
         this.setToolTipText(desc.toString());
@@ -426,20 +460,22 @@ public class AnnotationLabels extends JPanel implements MouseListener,
    */
   public void mouseClicked(MouseEvent evt)
   {
-    AlignmentAnnotation[] aa = ap.av.alignment.getAlignmentAnnotation();
+    AlignmentAnnotation[] aa = ap.av.getAlignment().getAlignmentAnnotation();
     if (SwingUtilities.isLeftMouseButton(evt))
     {
-      if (selectedRow < aa.length)
+      if (selectedRow > -1 && selectedRow < aa.length)
       {
         if (aa[selectedRow].groupRef != null)
         {
           if (evt.getClickCount() >= 2)
           {
-            // todo: make the ap scroll to the selection
+            // todo: make the ap scroll to the selection - not necessary, first click highlights/scrolls, second selects
             ap.seqPanel.ap.idPanel.highlightSearchResults(null);
             ap.av.setSelectionGroup(// new SequenceGroup(
-                    aa[selectedRow].groupRef); // );
+            aa[selectedRow].groupRef); // );
             ap.paintAlignment(false);
+            PaintRefresher.Refresh(ap, ap.av.getSequenceSetId());
+            ap.av.sendSelection();
           }
           else
           {
@@ -463,6 +499,7 @@ public class AnnotationLabels extends JPanel implements MouseListener,
             SequenceGroup sg = new SequenceGroup();
             sg.addSequence(aa[selectedRow].sequenceRef, false);
             ap.av.setSelectionGroup(sg);
+            ap.av.sendSelection();
             ap.paintAlignment(false);
             PaintRefresher.Refresh(ap, ap.av.getSequenceSetId());
           }
@@ -478,17 +515,18 @@ public class AnnotationLabels extends JPanel implements MouseListener,
     JPopupMenu pop = new JPopupMenu("Annotations");
     JMenuItem item = new JMenuItem(ADDNEW);
     item.addActionListener(this);
-
-    if ((aa == null) || (aa.length == 0))
+    pop.add(item);
+    if (selectedRow < 0)
     {
-      item = new JMenuItem(SHOWALL);
-      item.addActionListener(this);
-      pop.add(item);
+      if (hasHiddenRows)
+      { // let the user make everything visible again
+        item = new JMenuItem(SHOWALL);
+        item.addActionListener(this);
+        pop.add(item);
+      }
       pop.show(this, evt.getX(), evt.getY());
       return;
     }
-
-    pop.add(item);
     item = new JMenuItem(EDITNAME);
     item.addActionListener(this);
     pop.add(item);
@@ -498,9 +536,12 @@ public class AnnotationLabels extends JPanel implements MouseListener,
     item = new JMenuItem(DELETE);
     item.addActionListener(this);
     pop.add(item);
-    item = new JMenuItem(SHOWALL);
-    item.addActionListener(this);
-    pop.add(item);
+    if (hasHiddenRows)
+    {
+      item = new JMenuItem(SHOWALL);
+      item.addActionListener(this);
+      pop.add(item);
+    }
     item = new JMenuItem(OUTPUT_TEXT);
     item.addActionListener(this);
     pop.add(item);
@@ -528,8 +569,8 @@ public class AnnotationLabels extends JPanel implements MouseListener,
         final JCheckBoxMenuItem cbmi = new JCheckBoxMenuItem(
                 "Ignore Gaps In Consensus",
                 (aa[selectedRow].groupRef != null) ? aa[selectedRow].groupRef
-                        .getIgnoreGapsConsensus()
-                        : ap.av.getIgnoreGapsConsensus());
+                        .getIgnoreGapsConsensus() : ap.av
+                        .getIgnoreGapsConsensus());
         final AlignmentAnnotation aaa = aa[selectedRow];
         cbmi.addActionListener(new ActionListener()
         {
@@ -552,8 +593,8 @@ public class AnnotationLabels extends JPanel implements MouseListener,
         if (aaa.groupRef != null)
         {
           final JCheckBoxMenuItem chist = new JCheckBoxMenuItem(
-                  "Show Group Histogram", aa[selectedRow].groupRef
-                          .isShowConsensusHistogram());
+                  "Show Group Histogram",
+                  aa[selectedRow].groupRef.isShowConsensusHistogram());
           chist.addActionListener(new ActionListener()
           {
             public void actionPerformed(ActionEvent e)
@@ -570,10 +611,10 @@ public class AnnotationLabels extends JPanel implements MouseListener,
             }
           });
           pop.add(chist);
-          final JCheckBoxMenuItem cprof = new JCheckBoxMenuItem(
-                  "Show Group Logo", aa[selectedRow].groupRef
-                          .isShowSequenceLogo());
-          cprof.addActionListener(new ActionListener()
+          final JCheckBoxMenuItem cprofl = new JCheckBoxMenuItem(
+                  "Show Group Logo",
+                  aa[selectedRow].groupRef.isShowSequenceLogo());
+          cprofl.addActionListener(new ActionListener()
           {
             public void actionPerformed(ActionEvent e)
             {
@@ -583,12 +624,34 @@ public class AnnotationLabels extends JPanel implements MouseListener,
               // view
               // can be
               // updated.
-              aaa.groupRef.setIncludeAllConsSymbols(cprof.getState());
+              aaa.groupRef.setshowSequenceLogo(cprofl.getState());
               ap.repaint();
               // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
             }
           });
-          pop.add(cprof);
+          pop.add(cprofl);
+          final JCheckBoxMenuItem cproflnorm = new JCheckBoxMenuItem(
+                  "Normalise Group Logo",
+                  aa[selectedRow].groupRef.isNormaliseSequenceLogo());
+          cproflnorm.addActionListener(new ActionListener()
+          {
+            public void actionPerformed(ActionEvent e)
+            {
+              
+              // TODO: pass on reference
+              // to ap
+              // so the
+              // view
+              // can be
+              // updated.
+              aaa.groupRef.setNormaliseSequenceLogo(cproflnorm.getState());
+              // automatically enable logo display if we're clicked
+              aaa.groupRef.setshowSequenceLogo(true);
+              ap.repaint();
+              // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
+            }
+          });
+          pop.add(cproflnorm);
         }
         else
         {
@@ -605,6 +668,7 @@ public class AnnotationLabels extends JPanel implements MouseListener,
               // can be
               // updated.
               av.setShowConsensusHistogram(chist.getState());
+              ap.alignFrame.setMenusForViewport();
               ap.repaint();
               // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
             }
@@ -623,11 +687,32 @@ public class AnnotationLabels extends JPanel implements MouseListener,
               // can be
               // updated.
               av.setShowSequenceLogo(cprof.getState());
+              ap.alignFrame.setMenusForViewport();
               ap.repaint();
               // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
             }
           });
           pop.add(cprof);
+          final JCheckBoxMenuItem cprofnorm = new JCheckBoxMenuItem(
+                  "Normalise Logo", av.isNormaliseSequenceLogo());
+          cprofnorm.addActionListener(new ActionListener()
+          {
+            public void actionPerformed(ActionEvent e)
+            {
+              // TODO: pass on reference
+              // to ap
+              // so the
+              // view
+              // can be
+              // updated.
+              av.setShowSequenceLogo(true);
+              av.setNormaliseSequenceLogo(cprofnorm.getState());
+              ap.alignFrame.setMenusForViewport();
+              ap.repaint();
+              // ap.annotationPanel.paint(ap.annotationPanel.getGraphics());
+            }
+          });
+          pop.add(cprofnorm);
         }
         final JMenuItem consclipbrd = new JMenuItem(COPYCONS_SEQ);
         consclipbrd.addActionListener(this);
@@ -659,7 +744,7 @@ public class AnnotationLabels extends JPanel implements MouseListener,
       sq.setDatasetSequence(dseqs[0]);
     }
     Alignment ds = new Alignment(dseqs);
-    if (av.hasHiddenColumns)
+    if (av.hasHiddenColumns())
     {
       omitHidden = av.getColumnSelection().getVisibleSequenceStrings(0,
               sq.getLength(), seqs);
@@ -668,11 +753,11 @@ public class AnnotationLabels extends JPanel implements MouseListener,
     String output = new FormatAdapter().formatSequences("Fasta", seqs,
             omitHidden);
 
-    Toolkit.getDefaultToolkit().getSystemClipboard().setContents(
-            new StringSelection(output), Desktop.instance);
+    Toolkit.getDefaultToolkit().getSystemClipboard()
+            .setContents(new StringSelection(output), Desktop.instance);
 
     Vector hiddenColumns = null;
-    if (av.hasHiddenColumns)
+    if (av.hasHiddenColumns())
     {
       hiddenColumns = new Vector();
       for (int i = 0; i < av.getColumnSelection().getHiddenColumns().size(); i++)
@@ -741,7 +826,7 @@ public class AnnotationLabels extends JPanel implements MouseListener,
     g.translate(0, scrollOffset);
     g.setColor(Color.black);
 
-    AlignmentAnnotation[] aa = av.alignment.getAlignmentAnnotation();
+    AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
     int fontHeight = g.getFont().getSize();
     int y = 0;
     int x = 0;
@@ -750,12 +835,14 @@ public class AnnotationLabels extends JPanel implements MouseListener,
 
     if (aa != null)
     {
+      hasHiddenRows = false;
       for (int i = 0; i < aa.length; i++)
       {
         g.setColor(Color.black);
 
         if (!aa[i].visible)
         {
+          hasHiddenRows = true;
           continue;
         }
 
@@ -800,8 +887,8 @@ public class AnnotationLabels extends JPanel implements MouseListener,
                 g.setColor(aa[gg].annotations[0].colour);
               }
 
-              g.drawLine(x, y - graphExtras - 3, x
-                      + fm.stringWidth(aa[gg].label), y - graphExtras - 3);
+              g.drawLine(x, y - graphExtras - 3,
+                      x + fm.stringWidth(aa[gg].label), y - graphExtras - 3);
 
               g.setColor(Color.black);
               graphExtras += fontHeight + 8;
@@ -822,9 +909,8 @@ public class AnnotationLabels extends JPanel implements MouseListener,
     else if (dragEvent != null && aa != null)
     {
       g.setColor(Color.lightGray);
-      g.drawString(aa[selectedRow].label, dragEvent.getX(), dragEvent
-              .getY()
-              - scrollOffset);
+      g.drawString(aa[selectedRow].label, dragEvent.getX(),
+              dragEvent.getY() - scrollOffset);
     }
 
     if ((aa == null) || (aa.length < 1))