Merge branch 'JAL-986_idwidthprefs' into Release_2_7_Branch
authorjprocter <jprocter@compbio.dundee.ac.uk>
Wed, 9 Nov 2011 15:18:05 +0000 (15:18 +0000)
committerjprocter <jprocter@compbio.dundee.ac.uk>
Wed, 9 Nov 2011 15:18:05 +0000 (15:18 +0000)
.classpath
help/html/features/preferences.html
src/jalview/bin/Cache.java
src/jalview/gui/AlignmentPanel.java
src/jalview/gui/Preferences.java
src/jalview/jbgui/GPreferences.java

index d26fa6c..01cf242 100644 (file)
@@ -38,8 +38,8 @@
        <classpathentry kind="lib" path="lib/jswingreader-0.3.jar" sourcepath="/jswingreader"/>
        <classpathentry kind="lib" path="lib/min-jaba-client.jar"/>
        <classpathentry kind="lib" path="lib/commons-codec-1.3.jar"/>
-       <classpathentry kind="lib" path="appletlib/JmolApplet-12.2.0.jar" sourcepath="/Jmol"/>
        <classpathentry kind="lib" path="lib/Jmol-12.2.4.jar"/>
+       <classpathentry kind="lib" path="appletlib/JmolApplet-12.2.4.jar"/>
        <classpathentry kind="con" path="org.eclipse.jdt.USER_LIBRARY/plugin.jar"/>
        <classpathentry kind="output" path="classes"/>
 </classpath>
index 61e3eb0..7bc2a61 100755 (executable)
@@ -143,6 +143,11 @@ style for EPS export:
        make an EPS file.</li>
 </ul>
 </p>
+<p><em>Automatically set ID width</em><br>
+When enabled, the column containing sequence and annotation labels at the left hand side of an exported figure will be made large enough to display each sequence ID and annotation label in its own line. Enable this if you have particularly long sequence IDs and need to generate EPS or PNG figures or web pages.</p>
+<p><em>Figure ID column width</em><br>
+Manually specify the width of the left hand column where sequence IDs and annotation labels will be rendered in exported alignment figures. This setting will be ignored if <em>&quot;Automatically set ID width&quot;</em> is set.
+</p>
 <p><em>Sequence//Start-End Numbering</em><br>
 The output tab also has a group of checkboxes for each file format. If
 these are ticked, then Jalview will write files with the start and end
index ba1d0a8..069589e 100755 (executable)
@@ -133,6 +133,8 @@ import org.biojava.dasobert.dasregistry.Das1Source;
  * <li>ANNOTATIONCOLOUR_MAX (red) Shade used for maximum value of annotation when shading by annotation</li>
  * <li>www.jalview.org (http://www.jalview.org) a property enabling all HTTP requests to be redirected to a mirror of http://www.jalview.org</li>
  * 
+ * <li>FIGURE_AUTOIDWIDTH (false) Expand the left hand column of an exported alignment figure to accommodate even the longest sequence ID or annotation label.</li>
+ * <li>FIGURE_FIXEDIDWIDTH Specifies the width to use for the left-hand column when exporting an alignment as a figure (setting FIGURE_AUTOIDWIDTH to true will override this).</li>
  * <li></li>
  * 
  * </ul>
@@ -802,4 +804,24 @@ public class Cache
     }
     return null;
   }
+
+  /**
+   * get and parse a property as an integer. send any parsing problems to System.err
+   * @param property
+   * @return null or Integer
+   */
+  public static Integer getIntegerProperty(String property)
+  {
+    String val=getProperty(property);
+    if (val!=null && (val=val.trim()).length()>0)
+    {
+      try {
+        return Integer.valueOf(val);
+      } catch (NumberFormatException x)
+      {
+        System.err.println("Invalid integer in property '"+property+"' (value was '"+val+"')");
+      }
+    }
+    return null;
+  }
 }
index b7028ac..0155a67 100644 (file)
@@ -174,15 +174,28 @@ public class AlignmentPanel extends GAlignmentPanel implements
    */
   public Dimension calculateIdWidth()
   {
+    // calculate sensible default width when no preference is available
+    
+    int afwidth = (alignFrame != null ? alignFrame.getWidth() : 300);
+    int maxwidth = Math.max(20,
+            Math.min(afwidth - 200, (int) 2 * afwidth / 3));
+    return calculateIdWidth(maxwidth);
+  }
+  /**
+   * Calculate the width of the alignment labels based on the displayed names
+   * and any bounds on label width set in preferences.
+   * @param maxwidth -1 or maximum width allowed for IdWidth
+   * @return Dimension giving the maximum width of the alignment label panel
+   *         that should be used.
+   */
+  public Dimension calculateIdWidth(int maxwidth)
+  {
     Container c = new Container();
 
     FontMetrics fm = c.getFontMetrics(new Font(av.font.getName(),
             Font.ITALIC, av.font.getSize()));
 
     AlignmentI al = av.getAlignment();
-    int afwidth = (alignFrame != null ? alignFrame.getWidth() : 300);
-    int maxwidth = Math.max(20,
-            Math.min(afwidth - 200, (int) 2 * afwidth / 3));
     int i = 0;
     int idWidth = 0;
     String id;
@@ -221,7 +234,7 @@ public class AlignmentPanel extends GAlignmentPanel implements
       }
     }
 
-    return new Dimension(Math.min(maxwidth, idWidth), 12);
+    return new Dimension(maxwidth<0 ? idWidth : Math.min(maxwidth, idWidth), 12);
   }
 
   /**
@@ -789,7 +802,7 @@ public class AlignmentPanel extends GAlignmentPanel implements
   public int printUnwrapped(Graphics pg, int pwidth, int pheight, int pi)
           throws PrinterException
   {
-    int idWidth = getVisibleIdWidth();
+    int idWidth = getVisibleIdWidth(false);
     FontMetrics fm = getFontMetrics(av.getFont());
     int scaleHeight = av.charHeight + fm.getDescent();
 
@@ -956,7 +969,7 @@ public class AlignmentPanel extends GAlignmentPanel implements
     int cHeight = av.getAlignment().getHeight() * av.charHeight + hgap
             + annotationHeight;
 
-    int idWidth = getVisibleIdWidth();
+    int idWidth = getVisibleIdWidth(false);
 
     int maxwidth = av.alignment.getWidth();
     if (av.hasHiddenColumns)
@@ -1029,11 +1042,33 @@ public class AlignmentPanel extends GAlignmentPanel implements
       return Printable.NO_SUCH_PAGE;
     }
   }
-
+  /**
+   * get current sequence ID panel width, or nominal value if panel were to be displayed using default settings
+   * @return
+   */
   int getVisibleIdWidth()
   {
-    return idPanel.getWidth() > 0 ? idPanel.getWidth()
-            : calculateIdWidth().width + 4;
+    return getVisibleIdWidth(true);
+  }
+
+  /**
+   * get current sequence ID panel width, or nominal value if panel were to be displayed using default settings
+   * @param onscreen indicate if the Id width for onscreen or offscreen display should be returned
+   * @return
+   */
+  int getVisibleIdWidth(boolean onscreen)
+  {
+    // see if rendering offscreen - check preferences and calc width accordingly
+    if (!onscreen && Cache.getDefault("FIGURE_AUTOIDWIDTH", false))
+    {
+      return calculateIdWidth(-1).width+4;
+    }
+    Integer idwidth=null;
+    if (onscreen || (idwidth=Cache.getIntegerProperty("FIGURE_FIXEDIDWIDTH"))==null) {
+      return (idPanel.getWidth() > 0 ? idPanel.getWidth()
+            : calculateIdWidth().width + 4);
+    }
+    return idwidth.intValue()+4;
   }
 
   void makeAlignmentImage(int type, File file)
@@ -1046,7 +1081,7 @@ public class AlignmentPanel extends GAlignmentPanel implements
 
     int height = ((av.alignment.getHeight() + 1) * av.charHeight)
             + scalePanel.getHeight();
-    int width = getVisibleIdWidth() + (maxwidth * av.charWidth);
+    int width = getVisibleIdWidth(false) + (maxwidth * av.charWidth);
 
     if (av.getWrapAlignment())
     {
@@ -1054,14 +1089,16 @@ public class AlignmentPanel extends GAlignmentPanel implements
       if (System.getProperty("java.awt.headless") != null
               && System.getProperty("java.awt.headless").equals("true"))
       {
-        // TODO: JAL-244
+        // need to obtain default alignment width and then add in any additional allowance for id margin
+        // this duplicates the calculation in getWrappedHeight but adjusts for offscreen idWith
         width = alignFrame.getWidth() - vscroll.getPreferredSize().width
                 - alignFrame.getInsets().left
-                - alignFrame.getInsets().right;
+                - alignFrame.getInsets().right
+                - getVisibleIdWidth()+getVisibleIdWidth(false);
       }
       else
       {
-        width = seqPanel.getWidth() + getVisibleIdWidth();
+        width = seqPanel.getWidth() + getVisibleIdWidth(false);
       }
 
     }
@@ -1136,7 +1173,7 @@ public class AlignmentPanel extends GAlignmentPanel implements
   {
     // /////ONLY WORKS WITH NONE WRAPPED ALIGNMENTS
     // ////////////////////////////////////////////
-    int idWidth = getVisibleIdWidth();
+    int idWidth = getVisibleIdWidth(true);
     FontMetrics fm = getFontMetrics(av.getFont());
     int scaleHeight = av.charHeight + fm.getDescent();
 
index 27c455e..789799e 100755 (executable)
@@ -201,7 +201,11 @@ public class Preferences extends GPreferences
     epsRendering.addItem("Text");
     epsRendering.setSelectedItem(Cache.getDefault("EPS_RENDERING",
             "Prompt each time"));
-
+    autoIdWidth.setSelected(Cache.getDefault("FIGURE_AUTOIDWIDTH", false));
+    userIdWidth.setEnabled(autoIdWidth.isSelected());
+    userIdWidthlabel.setEnabled(autoIdWidth.isSelected());
+    Integer wi = Cache.getIntegerProperty("FIGURE_USERIDWIDTH");
+    userIdWidth.setText(wi == null ? "" : wi.toString());
     blcjv.setSelected(Cache.getDefault("BLC_JVSUFFIX", true));
     clustaljv.setSelected(Cache.getDefault("CLUSTAL_JVSUFFIX", true));
     fastajv.setSelected(Cache.getDefault("FASTA_JVSUFFIX", true));
@@ -450,6 +454,12 @@ public class Preferences extends GPreferences
             Boolean.toString(modellerOutput.isSelected()));
     jalview.io.PIRFile.useModellerOutput = modellerOutput.isSelected();
 
+    Cache.applicationProperties.setProperty("FIGURE_AUTOIDWIDTH",
+            Boolean.toString(autoIdWidth.isSelected()));
+    userIdWidth_actionPerformed();
+    Cache.applicationProperties.setProperty("FIGURE_USERIDWIDTH",
+                userIdWidth.getText());
+
     Cache.applicationProperties.setProperty("AUTO_CALC_CONSENSUS",
             Boolean.toString(autoCalculateConsCheck.isSelected()));
     Cache.applicationProperties.setProperty("SORT_BY_TREE",
@@ -675,4 +685,38 @@ public class Preferences extends GPreferences
     maxColour.repaint();
   }
 
+  @Override
+  protected void userIdWidth_actionPerformed()
+  {
+    try
+    {
+      String val = userIdWidth.getText().trim();
+      if (val.length() > 0)
+      {
+        Integer iw = Integer.parseInt(val);
+        if (iw.intValue() < 12)
+        {
+          throw new NumberFormatException();
+        }
+        userIdWidth.setText(iw.toString());
+      }
+    } catch (NumberFormatException x)
+    {
+      JOptionPane
+              .showInternalMessageDialog(
+                      Desktop.desktop,
+                      "The user defined width for the\nannotation and sequence ID columns\nin exported figures must be\nat least 12 pixels wide.",
+                      "Invalid ID Column width",
+                      JOptionPane.WARNING_MESSAGE);
+      userIdWidth.setText("");
+    }
+  }
+
+  @Override
+  protected void autoIdWidth_actionPerformed()
+  {
+    userIdWidth.setEnabled(!autoIdWidth.isSelected());
+    userIdWidthlabel.setEnabled(!autoIdWidth.isSelected());
+  }
+
 }
index 6cad0b5..29e11ce 100755 (executable)
@@ -160,6 +160,11 @@ public class GPreferences extends JPanel
   JLabel epsLabel = new JLabel();
 
   protected JComboBox epsRendering = new JComboBox();
+  
+  protected JLabel userIdWidthlabel = new JLabel();
+  protected JCheckBox autoIdWidth = new JCheckBox();
+  protected JTextField userIdWidth = new JTextField();
+
 
   JLabel jLabel1 = new JLabel();
 
@@ -635,9 +640,45 @@ public class GPreferences extends JPanel
     sortByTree.setText("Sort With New Tree");
     sortByTree.setToolTipText("When selected, any trees calculated or loaded onto the alignment will automatically sort the alignment.");
     sortByTree.setBounds(new Rectangle(22, 136, 168, 23));
+    
+    autoIdWidth.setFont(JvSwingUtils.getLabelFont());
+    autoIdWidth.setText("Automatically set ID width");
+    autoIdWidth.setToolTipText("<html>"+JvSwingUtils.wrapTooltip("Adjusts the width of the generated EPS or PNG file to ensure even the longest sequence ID or annotation label is displayed")+"</html>");
+    autoIdWidth.setBounds(new Rectangle(228, 96,188,23));
+    autoIdWidth.addActionListener(new ActionListener()
+    {
+      
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        autoIdWidth_actionPerformed();
+      }
+    });
+    userIdWidthlabel.setFont(JvSwingUtils.getLabelFont());
+    userIdWidthlabel.setText("Figure ID column width");
+    userIdWidth
+            .setToolTipText("<html>"+JvSwingUtils
+                    .wrapTooltip("Manually specify the width of the left hand column where sequence IDs and annotation labels will be rendered in exported alignment figures. This setting will be ignored if 'Automatically set ID width' is set")+"</html>");
+    userIdWidthlabel
+            .setToolTipText("<html>"+JvSwingUtils
+                    .wrapTooltip("Manually specify the width of the left hand column where sequence IDs and annotation labels will be rendered in exported alignment figures. This setting will be ignored if 'Automatically set ID width' is set")+"</html>");
+    userIdWidthlabel.setBounds(new Rectangle(236, 120,168,23));
+    userIdWidth.setFont(JvSwingUtils.getTextAreaFont());
+    userIdWidth.setText("");
+    userIdWidth.setBounds(new Rectangle(232,144,84,23));
+    userIdWidth.addActionListener(new ActionListener()
+    {
+      
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        userIdWidth_actionPerformed();
+      }
+    });
     modellerOutput.setFont(JvSwingUtils.getLabelFont());
     modellerOutput.setText("Use Modeller Output");
     modellerOutput.setBounds(new Rectangle(228, 226, 168, 23));
+
     dasPanel.setLayout(borderLayout4);
     wsPanel.setLayout(borderLayout5);
     wrap.setFont(JvSwingUtils.getLabelFont());
@@ -793,6 +834,9 @@ public class GPreferences extends JPanel
     jPanel11.add(pfamjv);
     jPanel11.add(pileupjv);
     jPanel11.add(pirjv);
+    exportTab.add(autoIdWidth);
+    exportTab.add(userIdWidth);
+    exportTab.add(userIdWidthlabel);
     exportTab.add(modellerOutput);
     tabbedPane.add(calcTab, "Editing");
     calcTab.add(autoCalculateConsCheck);
@@ -807,6 +851,18 @@ public class GPreferences extends JPanel
     exportTab.add(jPanel11);
   }
 
+  protected void autoIdWidth_actionPerformed()
+  {
+    // TODO Auto-generated method stub
+    
+  }
+
+  protected void userIdWidth_actionPerformed()
+  {
+    // TODO Auto-generated method stub
+    
+  }
+
   protected void maxColour_actionPerformed()
   {
     // TODO Auto-generated method stub