JAL-3048 JalviewJS compliant use of LineartOptions dialog
[jalview.git] / src / jalview / gui / TreePanel.java
index 35998eb..fefa77f 100755 (executable)
@@ -47,6 +47,7 @@ import jalview.io.NewickFile;
 import jalview.jbgui.GTreePanel;
 import jalview.util.ImageMaker;
 import jalview.util.MessageManager;
+import jalview.util.dialogrunner.RunResponse;
 import jalview.viewmodel.AlignmentViewport;
 
 import java.awt.Font;
@@ -55,14 +56,20 @@ import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
 import java.awt.image.BufferedImage;
 import java.beans.PropertyChangeEvent;
+import java.beans.PropertyChangeListener;
+import java.io.File;
 import java.io.FileOutputStream;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.concurrent.atomic.AtomicBoolean;
 
 import javax.imageio.ImageIO;
 import javax.swing.ButtonGroup;
 import javax.swing.JMenuItem;
+import javax.swing.JOptionPane;
 import javax.swing.JRadioButtonMenuItem;
+import javax.swing.event.InternalFrameAdapter;
+import javax.swing.event.InternalFrameEvent;
 
 import org.jibble.epsgraphics.EpsGraphics2D;
 
@@ -141,7 +148,35 @@ public class TreePanel extends GTreePanel
 
     buildAssociatedViewMenu();
 
-    av.addPropertyChangeListener(new java.beans.PropertyChangeListener()
+    final PropertyChangeListener listener = addAlignmentListener();
+
+    /*
+     * remove listener when window is closed, so that this
+     * panel can be garbage collected
+     */
+    addInternalFrameListener(new InternalFrameAdapter()
+    {
+      @Override
+      public void internalFrameClosed(InternalFrameEvent evt)
+      {
+        if (av != null)
+        {
+          av.removePropertyChangeListener(listener);
+        }
+      }
+    });
+
+    TreeLoader tl = new TreeLoader(newTree, inputData);
+    tl.start();
+
+  }
+
+  /**
+   * @return
+   */
+  protected PropertyChangeListener addAlignmentListener()
+  {
+    final PropertyChangeListener listener = new PropertyChangeListener()
     {
       @Override
       public void propertyChange(PropertyChangeEvent evt)
@@ -158,8 +193,8 @@ public class TreePanel extends GTreePanel
           }
           if (evt.getNewValue() == null)
           {
-            System.out
-                    .println("new alignment sequences vector value is null");
+            System.out.println(
+                    "new alignment sequences vector value is null");
           }
 
           tree.updatePlaceHolders((List<SequenceI>) evt.getNewValue());
@@ -168,11 +203,9 @@ public class TreePanel extends GTreePanel
           repaint();
         }
       }
-    });
-
-    TreeLoader tl = new TreeLoader(newTree, inputData);
-    tl.start();
-
+    };
+    av.addPropertyChangeListener(listener);
+    return listener;
   }
 
   @Override
@@ -183,8 +216,8 @@ public class TreePanel extends GTreePanel
 
   void buildAssociatedViewMenu()
   {
-    AlignmentPanel[] aps = PaintRefresher.getAssociatedPanels(av
-            .getSequenceSetId());
+    AlignmentPanel[] aps = PaintRefresher
+            .getAssociatedPanels(av.getSequenceSetId());
     if (aps.length == 1 && treeCanvas.ap == aps[0])
     {
       associateLeavesMenu.setVisible(false);
@@ -193,7 +226,8 @@ public class TreePanel extends GTreePanel
 
     associateLeavesMenu.setVisible(true);
 
-    if ((viewMenu.getItem(viewMenu.getItemCount() - 2) instanceof JMenuItem))
+    if ((viewMenu
+            .getItem(viewMenu.getItemCount() - 2) instanceof JMenuItem))
     {
       viewMenu.insertSeparator(viewMenu.getItemCount() - 1);
     }
@@ -275,11 +309,11 @@ public class TreePanel extends GTreePanel
       }
       else
       {
-        ScoreModelI sm = ScoreModels.getInstance().getScoreModel(
-                scoreModelName, treeCanvas.ap);
-        TreeBuilder njtree = treeType.equals(TreeBuilder.NEIGHBOUR_JOINING) ? new NJTree(
-                av, sm, similarityParams) : new AverageDistanceTree(av, sm,
-                similarityParams);
+        ScoreModelI sm = ScoreModels.getInstance()
+                .getScoreModel(scoreModelName, treeCanvas.ap);
+        TreeBuilder njtree = treeType.equals(TreeBuilder.NEIGHBOUR_JOINING)
+                ? new NJTree(av, sm, similarityParams)
+                : new AverageDistanceTree(av, sm, similarityParams);
         tree = new TreeModel(njtree);
         showDistances(true);
       }
@@ -360,11 +394,12 @@ public class TreePanel extends GTreePanel
   @Override
   public void saveAsNewick_actionPerformed(ActionEvent e)
   {
+    // TODO: JAL-3048 save newick file for Jalview-JS
     JalviewFileChooser chooser = new JalviewFileChooser(
             jalview.bin.Cache.getProperty("LAST_DIRECTORY"));
     chooser.setFileView(new JalviewFileView());
-    chooser.setDialogTitle(MessageManager
-            .getString("label.save_tree_as_newick"));
+    chooser.setDialogTitle(
+            MessageManager.getString("label.save_tree_as_newick"));
     chooser.setToolTipText(MessageManager.getString("action.save"));
 
     int value = chooser.showSaveDialog(null);
@@ -372,15 +407,15 @@ public class TreePanel extends GTreePanel
     if (value == JalviewFileChooser.APPROVE_OPTION)
     {
       String choice = chooser.getSelectedFile().getPath();
-      jalview.bin.Cache.setProperty("LAST_DIRECTORY", chooser
-              .getSelectedFile().getParent());
+      jalview.bin.Cache.setProperty("LAST_DIRECTORY",
+              chooser.getSelectedFile().getParent());
 
       try
       {
         jalview.io.NewickFile fout = new jalview.io.NewickFile(
                 tree.getTopNode());
-        String output = fout.print(tree.hasBootstrap(),
-                tree.hasDistances(), tree.hasRootDistance());
+        String output = fout.print(tree.hasBootstrap(), tree.hasDistances(),
+                tree.hasRootDistance());
         java.io.PrintWriter out = new java.io.PrintWriter(
                 new java.io.FileWriter(choice));
         out.println(output);
@@ -411,8 +446,8 @@ public class TreePanel extends GTreePanel
     AlignmentView originalData = tree.getOriginalData();
     if (originalData == null)
     {
-      jalview.bin.Cache.log
-              .info("Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action.");
+      jalview.bin.Cache.log.info(
+              "Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action.");
       return;
     }
     // decide if av alignment is sufficiently different to original data to
@@ -439,8 +474,9 @@ public class TreePanel extends GTreePanel
       // AlignmentOrder origorder = new AlignmentOrder(alAndColsel[0]);
 
       AlignmentI al = new Alignment((SequenceI[]) alAndColsel[0]);
-      AlignmentI dataset = (av != null && av.getAlignment() != null) ? av
-              .getAlignment().getDataset() : null;
+      AlignmentI dataset = (av != null && av.getAlignment() != null)
+              ? av.getAlignment().getDataset()
+              : null;
       if (dataset != null)
       {
         al.setDataset(dataset);
@@ -450,8 +486,7 @@ public class TreePanel extends GTreePanel
       {
         // make a new frame!
         AlignFrame af = new AlignFrame(al, (HiddenColumns) alAndColsel[1],
-                AlignFrame.DEFAULT_WIDTH,
-                AlignFrame.DEFAULT_HEIGHT);
+                AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 
         // >>>This is a fix for the moment, until a better solution is
         // found!!<<<
@@ -461,8 +496,8 @@ public class TreePanel extends GTreePanel
         // msaorder);
 
         Desktop.addInternalFrame(af, MessageManager.formatMessage(
-                "label.original_data_for_params",
-                new Object[] { this.title }), AlignFrame.DEFAULT_WIDTH,
+                "label.original_data_for_params", new Object[]
+                { this.title }), AlignFrame.DEFAULT_WIDTH,
                 AlignFrame.DEFAULT_HEIGHT);
       }
     }
@@ -492,9 +527,9 @@ public class TreePanel extends GTreePanel
 
     if (treeCanvas.applyToAllViews)
     {
-      final ArrayList<CommandI> commands = new ArrayList<CommandI>();
-      for (AlignmentPanel ap : PaintRefresher.getAssociatedPanels(av
-              .getSequenceSetId()))
+      final ArrayList<CommandI> commands = new ArrayList<>();
+      for (AlignmentPanel ap : PaintRefresher
+              .getAssociatedPanels(av.getSequenceSetId()))
       {
         commands.add(sortAlignmentIn(ap.av.getAlignPanel()));
       }
@@ -532,8 +567,8 @@ public class TreePanel extends GTreePanel
           }
         }
       });
-      for (AlignmentPanel ap : PaintRefresher.getAssociatedPanels(av
-              .getSequenceSetId()))
+      for (AlignmentPanel ap : PaintRefresher
+              .getAssociatedPanels(av.getSequenceSetId()))
       {
         // ensure all the alignFrames refresh their GI after adding an undo item
         ap.alignFrame.updateEditMenuBar();
@@ -549,13 +584,14 @@ public class TreePanel extends GTreePanel
 
   public CommandI sortAlignmentIn(AlignmentPanel ap)
   {
+    // TODO: move to alignment view controller
     AlignmentViewport viewport = ap.av;
     SequenceI[] oldOrder = viewport.getAlignment().getSequencesArray();
     AlignmentSorter.sortByTree(viewport.getAlignment(), tree);
     CommandI undo;
     undo = new OrderCommand("Tree Sort", oldOrder, viewport.getAlignment());
 
-    ap.paintAlignment(true);
+    ap.paintAlignment(true, false);
     return undo;
   }
 
@@ -626,74 +662,65 @@ public class TreePanel extends GTreePanel
   }
 
   /**
-   * DOCUMENT ME!
-   * 
-   * @param e
-   *          DOCUMENT ME!
+   * Outputs the Tree in EPS format. The user is prompted for the file to save
+   * to, and (unless a preference is already set) for the choice of Text or
+   * Lineart for character rendering.
    */
   @Override
-  public void epsTree_actionPerformed(ActionEvent e)
+  public void epsTree_actionPerformed()
   {
-    boolean accurateText = true;
-
-    String renderStyle = jalview.bin.Cache.getDefault("EPS_RENDERING",
-            "Prompt each time");
-
-    // If we need to prompt, and if the GUI is visible then
-    // Prompt for EPS rendering style
-    if (renderStyle.equalsIgnoreCase("Prompt each time")
-            && !(System.getProperty("java.awt.headless") != null && System
-                    .getProperty("java.awt.headless").equals("true")))
-    {
-      EPSOptions eps = new EPSOptions();
-      renderStyle = eps.getValue();
-
-      if (renderStyle == null || eps.cancelled)
-      {
-        return;
-      }
+    JalviewFileChooser chooser = new JalviewFileChooser(
+            ImageMaker.EPS_EXTENSION, ImageMaker.EPS_EXTENSION);
+    chooser.setFileView(new JalviewFileView());
+    chooser.setDialogTitle(
+            MessageManager.getString("label.create_eps_from_tree"));
+    chooser.setToolTipText(MessageManager.getString("action.save"));
 
-    }
+    int value = chooser.showSaveDialog(this);
 
-    if (renderStyle.equalsIgnoreCase("text"))
+    if (value != JalviewFileChooser.APPROVE_OPTION)
     {
-      accurateText = false;
+      return;
     }
+    File outFile = chooser.getSelectedFile();
+    Cache.setProperty("LAST_DIRECTORY", outFile.getParent());
 
-    int width = treeCanvas.getWidth();
-    int height = treeCanvas.getHeight();
+    String renderStyle = Cache.getDefault("EPS_RENDERING",
+            "Prompt each time");
+    AtomicBoolean textOption = new AtomicBoolean(
+            !"Lineart".equals(renderStyle));
 
-    try
+    /*
+     * configure the export action to run on OK in the dialog
+     */
+    RunResponse okAction = new RunResponse(JOptionPane.OK_OPTION)
     {
-      JalviewFileChooser chooser = new JalviewFileChooser(
-              ImageMaker.EPS_EXTENSION, ImageMaker.EPS_EXTENSION);
-      chooser.setFileView(new JalviewFileView());
-      chooser.setDialogTitle(MessageManager
-              .getString("label.create_eps_from_tree"));
-      chooser.setToolTipText(MessageManager.getString("action.save"));
-
-      int value = chooser.showSaveDialog(this);
-
-      if (value != JalviewFileChooser.APPROVE_OPTION)
+      @Override
+      public void run()
       {
-        return;
+        writeEpsFile(outFile, textOption.get());
       }
+    };
 
-      Cache.setProperty("LAST_DIRECTORY", chooser.getSelectedFile()
-              .getParent());
-
-      FileOutputStream out = new FileOutputStream(chooser.getSelectedFile());
-      EpsGraphics2D pg = new EpsGraphics2D("Tree", out, 0, 0, width, height);
-
-      pg.setAccurateTextMode(accurateText);
-
-      treeCanvas.draw(pg, width, height);
-
-      pg.flush();
-      pg.close();
-    } catch (Exception ex)
+    /*
+     * Prompt for character rendering style if preference is not set
+     */
+    if (renderStyle.equalsIgnoreCase("Prompt each time")
+            && !(System.getProperty("java.awt.headless") != null && System
+                    .getProperty("java.awt.headless").equals("true")))
     {
-      ex.printStackTrace();
+      LineartOptions eps = new LineartOptions("EPS_RENDERING", "EPS",
+              textOption);
+      eps.setResponseAction(okAction);
+      eps.showDialog();
+      /* no code here - JalviewJS won't execute it */
+    }
+    else
+    {
+      /*
+       * if preference set, just run the export action
+       */
+      writeEpsFile(outFile, textOption.get());
     }
   }
 
@@ -715,8 +742,8 @@ public class TreePanel extends GTreePanel
               ImageMaker.PNG_EXTENSION, ImageMaker.PNG_DESCRIPTION);
 
       chooser.setFileView(new jalview.io.JalviewFileView());
-      chooser.setDialogTitle(MessageManager
-              .getString("label.create_png_from_tree"));
+      chooser.setDialogTitle(
+              MessageManager.getString("label.create_png_from_tree"));
       chooser.setToolTipText(MessageManager.getString("action.save"));
 
       int value = chooser.showSaveDialog(this);
@@ -726,10 +753,11 @@ public class TreePanel extends GTreePanel
         return;
       }
 
-      jalview.bin.Cache.setProperty("LAST_DIRECTORY", chooser
-              .getSelectedFile().getParent());
+      jalview.bin.Cache.setProperty("LAST_DIRECTORY",
+              chooser.getSelectedFile().getParent());
 
-      FileOutputStream out = new FileOutputStream(chooser.getSelectedFile());
+      FileOutputStream out = new FileOutputStream(
+              chooser.getSelectedFile());
 
       BufferedImage bi = new BufferedImage(width, height,
               BufferedImage.TYPE_INT_RGB);
@@ -770,9 +798,9 @@ public class TreePanel extends GTreePanel
           if (sq != null)
           {
             // search dbrefs, features and annotation
-            DBRefEntry[] refs = jalview.util.DBRefUtils.selectRefs(
-                    sq.getDBRefs(),
-                    new String[] { labelClass.toUpperCase() });
+            DBRefEntry[] refs = jalview.util.DBRefUtils
+                    .selectRefs(sq.getDBRefs(), new String[]
+                    { labelClass.toUpperCase() });
             if (refs != null)
             {
               for (int i = 0; i < refs.length; i++)
@@ -789,19 +817,17 @@ public class TreePanel extends GTreePanel
             }
             if (newname == null)
             {
-              SequenceFeature sf[] = sq.getSequenceFeatures();
-              for (int i = 0; sf != null && i < sf.length; i++)
+              List<SequenceFeature> features = sq.getFeatures()
+                      .getPositionalFeatures(labelClass);
+              for (SequenceFeature feature : features)
               {
-                if (sf[i].getType().equals(labelClass))
+                if (newname == null)
+                {
+                  newname = feature.getDescription();
+                }
+                else
                 {
-                  if (newname == null)
-                  {
-                    newname = new String(sf[i].getDescription());
-                  }
-                  else
-                  {
-                    newname = newname + "; " + sf[i].getDescription();
-                  }
+                  newname = newname + "; " + feature.getDescription();
                 }
               }
             }
@@ -823,6 +849,7 @@ public class TreePanel extends GTreePanel
    * Neighbour Joining Using BLOSUM62
    * <p>
    * For a tree loaded from file, just uses the file name
+   * 
    * @return
    */
   public String getPanelTitle()
@@ -835,8 +862,8 @@ public class TreePanel extends GTreePanel
     /*
      * i18n description of Neighbour Joining or Average Distance method
      */
-    String treecalcnm = MessageManager.getString("label.tree_calc_"
-            + treeType.toLowerCase());
+    String treecalcnm = MessageManager
+            .getString("label.tree_calc_" + treeType.toLowerCase());
 
     /*
      * short score model name (long description can be too long)
@@ -850,4 +877,34 @@ public class TreePanel extends GTreePanel
             treecalcnm, smn);
     return ttl;
   }
+
+  /**
+   * Builds an EPS image and writes it to the specified file.
+   * 
+   * @param outFile
+   * @param textOption
+   *          true for Text character rendering, false for Lineart
+   */
+  protected void writeEpsFile(File outFile, boolean textOption)
+  {
+    try
+    {
+      int width = treeCanvas.getWidth();
+      int height = treeCanvas.getHeight();
+
+      FileOutputStream out = new FileOutputStream(
+              outFile);
+      EpsGraphics2D pg = new EpsGraphics2D("Tree", out, 0, 0, width,
+              height);
+      pg.setAccurateTextMode(!textOption);
+      treeCanvas.draw(pg, width, height);
+
+      pg.flush();
+      pg.close();
+    } catch (Exception ex)
+    {
+      System.err.println("Error writing tree as EPS");
+      ex.printStackTrace();
+    }
+  }
 }