JAL-3446 from applet, JAL-3584 tooltip fixes <br> and allows different patch/JAL-3584_cherrypickto-JAL-3676_2.11.1.1
authorBobHanson <hansonr@stolaf.edu>
Wed, 10 Jun 2020 15:52:59 +0000 (10:52 -0500)
committerJim Procter <jprocter@issues.jalview.org>
Thu, 10 Sep 2020 16:39:06 +0000 (17:39 +0100)
html style coding for Java and JavaScript
 Conflicts:
src/jalview/gui/JvSwingUtils.java

src/jalview/gui/JvSwingUtils.java
src/jalview/io/SequenceAnnotationReport.java
src/jalview/jbgui/GAlignFrame.java
test/jalview/io/SequenceAnnotationReportTest.java

index 7a5dde6..c561457 100644 (file)
@@ -48,6 +48,9 @@ import javax.swing.SwingConstants;
 import javax.swing.border.Border;
 import javax.swing.border.TitledBorder;
 
+import jalview.util.MessageManager;
+import jalview.util.Platform;
+
 /**
  * useful functions for building Swing GUIs
  * 
@@ -56,6 +59,12 @@ import javax.swing.border.TitledBorder;
  */
 public final class JvSwingUtils
 {
+  // JBPMerge note: Old Non-JS prefix
+  // static final String HTML_PREFIX = "<html><div
+  // style=\"width:350px;white-space:pre-wrap;margin:2px;overflow-wrap:break-word;\">";
+
+  static final String HTML_PREFIX = "<html><div style=\"width:350; text-align: justify; word-wrap: break-word;\">";
+
   /**
    * wrap a bare html safe string to around 60 characters per line using a CSS
    * style class specifying word-wrap and break-word
@@ -72,33 +81,37 @@ public final class JvSwingUtils
             "Tootip text to format must not be null!");
     ttext = ttext.trim();
     boolean maxLengthExceeded = false;
-
-    if (ttext.contains("<br>"))
+    boolean isHTML = ttext.startsWith("<html>");
+    if (isHTML)
     {
-      String[] htmllines = ttext.split("<br>");
-      for (String line : htmllines)
-      {
-        maxLengthExceeded = line.length() > 60;
-        if (maxLengthExceeded)
-        {
+      ttext = ttext.substring(6);
+    }
+    if (ttext.endsWith("</html>"))
+    {
+      isHTML = true;
+      ttext = ttext.substring(0, ttext.length() - 7);
+    }
+    boolean hasBR = ttext.contains("<br>");
+    enclose |= isHTML || hasBR;
+    if (hasBR)
+    {  
+      int pt = -1, ptlast = -4;
+      while ((pt = ttext.indexOf("<br>", pt + 1)) >= 0) {
+        if (pt - ptlast - 4 > 60) {
+          maxLengthExceeded = true;
           break;
         }
       }
     }
-    else
+    else  
     {
       maxLengthExceeded = ttext.length() > 60;
     }
 
-    if (!maxLengthExceeded)
-    {
-      return enclose ? "<html>" + ttext + "</html>" : ttext;
-    }
-
-    return (enclose ? "<html>" : "")
-            + "<style> p.ttip {width: 350; text-align: left; word-wrap: break-word;}</style><p class=\"ttip\">"
-            + ttext + "</p>" + ((enclose ? "</html>" : ""));
-
+    String ret = (!enclose ? ttext : maxLengthExceeded ? HTML_PREFIX + ttext + "</div></html>" :
+      "<html>" + ttext + "</html>");
+    //System.out.println("JvSwUtil " + enclose + " " + maxLengthExceeded + " " + ret);
+    return ret;
   }
 
   public static JButton makeButton(String label, String tooltip,
index 27c1652..ecb5a98 100644 (file)
@@ -240,7 +240,7 @@ public class SequenceAnnotationReport
       {
         if (sb0.length() > 6)
         {
-          sb.append("<br/>");
+          sb.append("<br>");
         }
         sb.append(feature.getType()).append(" ").append(begin).append(":")
                 .append(end);
@@ -250,7 +250,7 @@ public class SequenceAnnotationReport
 
     if (sb0.length() > 6)
     {
-      sb.append("<br/>");
+      sb.append("<br>");
     }
     // TODO: remove this hack to display link only features
     boolean linkOnly = feature.getValue("linkonly") != null;
@@ -279,7 +279,9 @@ public class SequenceAnnotationReport
         int linkindex = description.toLowerCase().indexOf("<a ");
         boolean hasLink = linkindex > -1
                 && linkindex < MAX_DESCRIPTION_LENGTH;
-        if (description.length() > MAX_DESCRIPTION_LENGTH && !hasLink)
+        if (
+                // BH suggestion maxlength == 0 && 
+                description.length() > MAX_DESCRIPTION_LENGTH && !hasLink)
         {
           description = description.substring(0, MAX_DESCRIPTION_LENGTH)
                   + ELLIPSIS;
@@ -398,7 +400,7 @@ public class SequenceAnnotationReport
           {
             for (List<String> urllink : createLinksFrom(null, urlstring))
             {
-              sb.append("<br/> <a href=\""
+              sb.append("<br> <a href=\""
                       + urllink.get(3)
                       + "\" target=\""
                       + urllink.get(0)
@@ -407,7 +409,7 @@ public class SequenceAnnotationReport
                               .equals(urllink.get(1).toLowerCase()) ? urllink
                               .get(0) : (urllink.get(0) + ":" + urllink
                                               .get(1)))
-                      + "</a><br/>");
+                      + "</a><br>");
             }
           } catch (Exception x)
           {
@@ -564,7 +566,7 @@ public class SequenceAnnotationReport
       countForSource++;
       if (countForSource == 1 || !summary)
       {
-        sb.append("<br/>");
+        sb.append("<br>");
       }
       if (countForSource <= MAX_REFS_PER_SOURCE || !summary)
       {
@@ -590,11 +592,11 @@ public class SequenceAnnotationReport
     }
     if (moreSources)
     {
-      sb.append("<br/>").append(source).append(COMMA).append(ELLIPSIS);
+      sb.append("<br>").append(source).append(COMMA).append(ELLIPSIS);
     }
     if (ellipsis)
     {
-      sb.append("<br/>(");
+      sb.append("<br>(");
       sb.append(MessageManager.getString("label.output_seq_details"));
       sb.append(")");
     }
index 075b490..8c945f0 100755 (executable)
@@ -1696,8 +1696,8 @@ public class GAlignFrame extends JInternalFrame
     });
     JMenuItem selectHighlighted = new JMenuItem(
             MessageManager.getString("action.select_highlighted_columns"));
-    selectHighlighted.setToolTipText(
-            MessageManager.getString("tooltip.select_highlighted_columns"));
+    selectHighlighted.setToolTipText(JvSwingUtils.wrapTooltip(true, 
+            MessageManager.getString("tooltip.select_highlighted_columns")));
     al = new ActionListener()
     {
       @Override
index 772ed2b..f3a7586 100644 (file)
@@ -69,15 +69,15 @@ public class SequenceAnnotationReportTest
     sar.appendFeature(sb, 2, null, sf, null, 0);
     assertEquals("123456", sb.toString());
 
-    // residuePos == 1 matches start of feature, text appended (but no <br/>)
+    // residuePos == 1 matches start of feature, text appended (but no <br>)
     // feature score is not included
     sar.appendFeature(sb, 1, null, sf, null, 0);
     assertEquals("123456disulfide bond 1:3", sb.toString());
 
     // residuePos == 3 matches end of feature, text appended
-    // <br/> is prefixed once sb.length() > 6
+    // <br> is prefixed once sb.length() > 6
     sar.appendFeature(sb, 3, null, sf, null, 0);
-    assertEquals("123456disulfide bond 1:3<br/>disulfide bond 1:3",
+    assertEquals("123456disulfide bond 1:3<br>disulfide bond 1:3",
             sb.toString());
   }
 
@@ -147,8 +147,8 @@ public class SequenceAnnotationReportTest
      */
     minmax.put("METAL", new float[][] { { 0f, 1f }, null });
     sar.appendFeature(sb, 1, fr, sf, null, 0);
-    // <br/> is appended to a buffer > 6 in length
-    assertEquals("METAL 1 3; Fe2-S<br/>METAL 1 3; Fe2-S Score=1.3",
+    // <br> is appended to a buffer > 6 in length
+    assertEquals("METAL 1 3; Fe2-S<br>METAL 1 3; Fe2-S Score=1.3",
             sb.toString());
 
     /*
@@ -299,7 +299,7 @@ public class SequenceAnnotationReportTest
             null));
     sb.setLength(0);
     sar.createSequenceAnnotationReport(sb, seq, true, true, null);
-    String expected = "<i>SeqDesc<br/>Type1 ; Nonpos Score=1.0</i>";
+    String expected = "<i>SeqDesc<br>Type1 ; Nonpos Score=1.0</i>";
     assertEquals(expected, sb.toString());
 
     /*
@@ -324,7 +324,7 @@ public class SequenceAnnotationReportTest
 
     sb.setLength(0);
     sar.createSequenceAnnotationReport(sb, seq, true, true, fr);
-    expected = "<i>SeqDesc<br/>Metal ; Desc<br/>Type1 ; Nonpos</i>";
+    expected = "<i>SeqDesc<br>Metal ; Desc<br>Type1 ; Nonpos</i>";
     assertEquals(expected, sb.toString());
     
     /*
@@ -349,7 +349,7 @@ public class SequenceAnnotationReportTest
     seq.addSequenceFeature(sf2);
     sb.setLength(0);
     sar.createSequenceAnnotationReport(sb, seq, true, true, fr);
-    expected = "<i>SeqDesc<br/>Metal ; Desc<br/>Type1 ; Nonpos<br/>Variant ; Havana</i>";
+    expected = "<i>SeqDesc<br>Metal ; Desc<br>Type1 ; Nonpos<br>Variant ; Havana</i>";
     assertEquals(expected, sb.toString());
 
     /*
@@ -370,13 +370,13 @@ public class SequenceAnnotationReportTest
     fc.setAttributeName("clinical_significance");
     fr.setColour("Variant", fc);
     sar.createSequenceAnnotationReport(sb, seq, true, true, fr);
-    expected = "<i>SeqDesc<br/>UNIPROT P30419<br/>PDB 3iu1<br/>Metal ; Desc<br/>"
-            + "Type1 ; Nonpos<br/>Variant ; Havana; clinical_significance=benign</i>";
+    expected = "<i>SeqDesc<br>UNIPROT P30419<br>PDB 3iu1<br>Metal ; Desc<br>"
+            + "Type1 ; Nonpos<br>Variant ; Havana; clinical_significance=benign</i>";
     assertEquals(expected, sb.toString());
     // with showNonPositionalFeatures = false
     sb.setLength(0);
     sar.createSequenceAnnotationReport(sb, seq, true, false, fr);
-    expected = "<i>SeqDesc<br/>UNIPROT P30419<br/>PDB 3iu1</i>";
+    expected = "<i>SeqDesc<br>UNIPROT P30419<br>PDB 3iu1</i>";
     assertEquals(expected, sb.toString());
 
     /*
@@ -386,7 +386,7 @@ public class SequenceAnnotationReportTest
     sf2.setDescription(
             "This is a very long description which should be truncated");
     sar.createSequenceAnnotationReport(sb, seq, false, true, fr);
-    expected = "<i>SeqDesc<br/>Metal ; Desc<br/>Type1 ; Nonpos<br/>Variant ; This is a very long description which sh...; clinical_significance=benign</i>";
+    expected = "<i>SeqDesc<br>Metal ; Desc<br>Type1 ; Nonpos<br>Variant ; This is a very long description which sh...; clinical_significance=benign</i>";
     assertEquals(expected, sb.toString());
 
     // see other tests for treatment of status and html
@@ -421,10 +421,10 @@ public class SequenceAnnotationReportTest
     String report = sb.toString();
     assertTrue(report
             .startsWith(
-                    "<i><br/>UNIPROT P30410, P30411, P30412, P30413,...<br/>PDB0 3iu1"));
+                    "<i><br>UNIPROT P30410, P30411, P30412, P30413,...<br>PDB0 3iu1"));
     assertTrue(report
             .endsWith(
-                    "<br/>PDB7 3iu1<br/>PDB8,...<br/>(Output Sequence Details to list all database references)</i>"));
+                    "<br>PDB7 3iu1<br>PDB8,...<br>(Output Sequence Details to list all database references)</i>"));
   }
 
   /**