X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FTreePanel.java;h=f708c482f9497054a931acc05f355196caed5226;hb=HEAD;hp=5e14fce7d3fa1410e1ed54ae8b041c08e26941e0;hpb=be762d8d9c71a7aa3121e845c45911c7192b7827;p=jalview.git diff --git a/src/jalview/gui/TreePanel.java b/src/jalview/gui/TreePanel.java index 5e14fce..f708c48 100755 --- a/src/jalview/gui/TreePanel.java +++ b/src/jalview/gui/TreePanel.java @@ -20,6 +20,28 @@ */ package jalview.gui; +import java.awt.Font; +import java.awt.Graphics; +import java.awt.event.ActionEvent; +import java.awt.event.ActionListener; +import java.awt.event.KeyAdapter; +import java.awt.event.KeyEvent; +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.Locale; + +import javax.swing.ButtonGroup; +import javax.swing.JMenuItem; +import javax.swing.JRadioButtonMenuItem; +import javax.swing.event.InternalFrameAdapter; +import javax.swing.event.InternalFrameEvent; + +import org.jibble.epsgraphics.EpsGraphics2D; + import jalview.analysis.AlignmentSorter; import jalview.analysis.AverageDistanceTree; import jalview.analysis.NJTree; @@ -29,9 +51,11 @@ import jalview.analysis.scoremodels.ScoreModels; import jalview.api.analysis.ScoreModelI; import jalview.api.analysis.SimilarityParamsI; import jalview.bin.Cache; +import jalview.bin.Console; import jalview.commands.CommandI; import jalview.commands.OrderCommand; import jalview.datamodel.Alignment; +import jalview.datamodel.AlignmentAnnotation; import jalview.datamodel.AlignmentI; import jalview.datamodel.AlignmentView; import jalview.datamodel.BinaryNode; @@ -41,31 +65,16 @@ import jalview.datamodel.NodeTransformI; import jalview.datamodel.SequenceFeature; import jalview.datamodel.SequenceI; import jalview.datamodel.SequenceNode; +import jalview.gui.ImageExporter.ImageWriterI; import jalview.io.JalviewFileChooser; import jalview.io.JalviewFileView; import jalview.io.NewickFile; +import jalview.io.exceptions.ImageOutputException; import jalview.jbgui.GTreePanel; -import jalview.util.ImageMaker; +import jalview.util.ImageMaker.TYPE; import jalview.util.MessageManager; import jalview.viewmodel.AlignmentViewport; -import java.awt.Font; -import java.awt.Graphics; -import java.awt.event.ActionEvent; -import java.awt.event.ActionListener; -import java.awt.image.BufferedImage; -import java.beans.PropertyChangeEvent; -import java.io.FileOutputStream; -import java.util.ArrayList; -import java.util.List; - -import javax.imageio.ImageIO; -import javax.swing.ButtonGroup; -import javax.swing.JMenuItem; -import javax.swing.JRadioButtonMenuItem; - -import org.jibble.epsgraphics.EpsGraphics2D; - /** * DOCUMENT ME! * @@ -82,11 +91,11 @@ public class TreePanel extends GTreePanel SimilarityParamsI similarityParams; - TreeCanvas treeCanvas; + private TreeCanvas treeCanvas; TreeModel tree; - AlignViewport av; + private AlignViewport av; /** * Creates a new TreePanel object. @@ -100,6 +109,7 @@ public class TreePanel extends GTreePanel SimilarityParamsI options) { super(); + this.setFrameIcon(null); this.similarityParams = options; initTreePanel(ap, type, modelName, null, null); @@ -112,18 +122,53 @@ public class TreePanel extends GTreePanel String theTitle, AlignmentView inputData) { super(); + this.setFrameIcon(null); this.treeTitle = theTitle; initTreePanel(alignPanel, null, null, newtree, inputData); } + /** + * columnwise tree associated with positions in aa + * + * @param alignPanel + * @param fin + * @param title + * @param aa + */ + public TreePanel(AlignmentPanel alignPanel, NewickFile fin, + AlignmentAnnotation aa, String title) + { + super(); + columnWise = true; + assocAnnotation = aa; + this.setFrameIcon(null); + this.treeTitle = title; + initTreePanel(alignPanel, null, null, fin, null); + } + + boolean columnWise = false; + + AlignmentAnnotation assocAnnotation = null; + + public boolean isColumnWise() + { + return columnWise; + } + + public AlignmentAnnotation getAssocAnnotation() + { + return assocAnnotation; + } + public AlignmentI getAlignment() { - return treeCanvas.av.getAlignment(); + return getTreeCanvas().getViewport().getAlignment(); } public AlignmentViewport getViewPort() { - return treeCanvas.av; + // @Mungo - Why don't we return our own viewport ??? + return getTreeCanvas().getViewport(); } void initTreePanel(AlignmentPanel ap, String type, String modelName, @@ -137,11 +182,76 @@ public class TreePanel extends GTreePanel treeCanvas = new TreeCanvas(this, ap, scrollPane); scrollPane.setViewportView(treeCanvas); + if (columnWise) + { + bootstrapMenu.setVisible(false); + placeholdersMenu.setState(false); + placeholdersMenu.setVisible(false); + fitToWindow.setState(false); + sortAssocViews.setVisible(false); + } + + addKeyListener(new KeyAdapter() + { + @Override + public void keyPressed(KeyEvent e) + { + switch (e.getKeyCode()) + { + case 27: // escape + treeCanvas.clearSelectedLeaves(); + e.consume(); + break; + + } + + } + }); PaintRefresher.Register(this, ap.av.getSequenceSetId()); 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); + } + releaseReferences(); + } + }); + + TreeLoader tl = new TreeLoader(newTree, inputData); + tl.start(); + + } + + /** + * Ensure any potentially large object references are nulled + */ + public void releaseReferences() + { + this.tree = null; + this.treeCanvas.tree = null; + this.treeCanvas.nodeHash = null; + this.treeCanvas.nameHash = null; + } + + /** + * @return + */ + protected PropertyChangeListener addAlignmentListener() + { + final PropertyChangeListener listener = new PropertyChangeListener() { @Override public void propertyChange(PropertyChangeEvent evt) @@ -150,7 +260,7 @@ public class TreePanel extends GTreePanel { if (tree == null) { - System.out.println("tree is null"); + jalview.bin.Console.outPrintln("tree is null"); // TODO: deal with case when a change event is received whilst a // tree is still being calculated - should save reference for // processing message later. @@ -158,7 +268,7 @@ public class TreePanel extends GTreePanel } if (evt.getNewValue() == null) { - System.out.println( + jalview.bin.Console.outPrintln( "new alignment sequences vector value is null"); } @@ -168,11 +278,9 @@ public class TreePanel extends GTreePanel repaint(); } } - }); - - TreeLoader tl = new TreeLoader(newTree, inputData); - tl.start(); - + }; + av.addPropertyChangeListener(listener); + return listener; } @Override @@ -185,7 +293,7 @@ public class TreePanel extends GTreePanel { AlignmentPanel[] aps = PaintRefresher .getAssociatedPanels(av.getSequenceSetId()); - if (aps.length == 1 && treeCanvas.ap == aps[0]) + if (aps.length == 1 && getTreeCanvas().getAssociatedPanel() == aps[0]) { associateLeavesMenu.setVisible(false); return; @@ -208,7 +316,8 @@ public class TreePanel extends GTreePanel for (i = 0; i < iSize; i++) { final AlignmentPanel ap = aps[i]; - item = new JRadioButtonMenuItem(ap.av.viewName, ap == treeCanvas.ap); + item = new JRadioButtonMenuItem(ap.av.getViewName(), + ap == treeCanvas.getAssociatedPanel()); buttonGroup.add(item); item.addActionListener(new ActionListener() { @@ -216,8 +325,8 @@ public class TreePanel extends GTreePanel public void actionPerformed(ActionEvent evt) { treeCanvas.applyToAllViews = false; - treeCanvas.ap = ap; - treeCanvas.av = ap.av; + treeCanvas.setAssociatedPanel(ap); + treeCanvas.setViewport(ap.av); PaintRefresher.Register(thisTreePanel, ap.av.getSequenceSetId()); } }); @@ -276,15 +385,15 @@ public class TreePanel extends GTreePanel } else { - ScoreModelI sm = ScoreModels.getInstance() - .getScoreModel(scoreModelName, treeCanvas.ap); + ScoreModelI sm = ScoreModels.getInstance().getScoreModel( + scoreModelName, treeCanvas.getAssociatedPanel()); TreeBuilder njtree = treeType.equals(TreeBuilder.NEIGHBOUR_JOINING) ? new NJTree(av, sm, similarityParams) : new AverageDistanceTree(av, sm, similarityParams); tree = new TreeModel(njtree); - showDistances(true); + // don't display distances for columnwise trees } - + showDistances(!columnWise); tree.reCount(tree.getTopNode()); tree.findHeight(tree.getTopNode()); treeCanvas.setTree(tree); @@ -361,8 +470,9 @@ 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")); + Cache.getProperty("LAST_DIRECTORY")); chooser.setFileView(new JalviewFileView()); chooser.setDialogTitle( MessageManager.getString("label.save_tree_as_newick")); @@ -373,7 +483,7 @@ public class TreePanel extends GTreePanel if (value == JalviewFileChooser.APPROVE_OPTION) { String choice = chooser.getSelectedFile().getPath(); - jalview.bin.Cache.setProperty("LAST_DIRECTORY", + Cache.setProperty("LAST_DIRECTORY", chooser.getSelectedFile().getParent()); try @@ -412,7 +522,7 @@ public class TreePanel extends GTreePanel AlignmentView originalData = tree.getOriginalData(); if (originalData == null) { - jalview.bin.Cache.log.info( + Console.info( "Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action."); return; } @@ -493,7 +603,7 @@ public class TreePanel extends GTreePanel if (treeCanvas.applyToAllViews) { - final ArrayList commands = new ArrayList(); + final ArrayList commands = new ArrayList<>(); for (AlignmentPanel ap : PaintRefresher .getAssociatedPanels(av.getSequenceSetId())) { @@ -542,21 +652,22 @@ public class TreePanel extends GTreePanel } else { - treeCanvas.ap.alignFrame - .addHistoryItem(sortAlignmentIn(treeCanvas.ap)); + treeCanvas.getAssociatedPanel().alignFrame.addHistoryItem( + sortAlignmentIn(treeCanvas.getAssociatedPanel())); } } 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; } @@ -627,125 +738,35 @@ public class TreePanel extends GTreePanel } /** - * DOCUMENT ME! - * - * @param e - * DOCUMENT ME! + * Outputs the Tree in image format (currently EPS or PNG). The user is + * prompted for the file to save to, and for EPS (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 writeTreeImage(TYPE imageFormat) { - 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; - } - - } - - if (renderStyle.equalsIgnoreCase("text")) - { - accurateText = false; - } - int width = treeCanvas.getWidth(); int height = treeCanvas.getHeight(); - - try + ImageWriterI writer = new ImageWriterI() { - 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 exportImage(Graphics g) throws Exception { - return; + treeCanvas.draw(g, width, height); } - - 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) - { - ex.printStackTrace(); - } - } - - /** - * DOCUMENT ME! - * - * @param e - * DOCUMENT ME! - */ - @Override - public void pngTree_actionPerformed(ActionEvent e) - { - int width = treeCanvas.getWidth(); - int height = treeCanvas.getHeight(); - + }; + String tree = MessageManager.getString("label.tree"); + ImageExporter exporter = new ImageExporter(writer, null, imageFormat, + tree); try { - JalviewFileChooser chooser = new JalviewFileChooser( - ImageMaker.PNG_EXTENSION, ImageMaker.PNG_DESCRIPTION); - - chooser.setFileView(new jalview.io.JalviewFileView()); - chooser.setDialogTitle( - MessageManager.getString("label.create_png_from_tree")); - chooser.setToolTipText(MessageManager.getString("action.save")); - - int value = chooser.showSaveDialog(this); - - if (value != jalview.io.JalviewFileChooser.APPROVE_OPTION) - { - return; - } - - jalview.bin.Cache.setProperty("LAST_DIRECTORY", - chooser.getSelectedFile().getParent()); - - FileOutputStream out = new FileOutputStream( - chooser.getSelectedFile()); - - BufferedImage bi = new BufferedImage(width, height, - BufferedImage.TYPE_INT_RGB); - Graphics png = bi.getGraphics(); - - treeCanvas.draw(png, width, height); - - ImageIO.write(bi, "png", out); - out.close(); - } catch (Exception ex) + exporter.doExport(null, this, width, height, + tree.toLowerCase(Locale.ROOT)); + } catch (ImageOutputException ioex) { - ex.printStackTrace(); + Console.error( + "Unexpected error whilst writing " + imageFormat.toString(), + ioex); } } @@ -770,24 +791,24 @@ public class TreePanel extends GTreePanel && !((SequenceNode) node).isDummy()) { String newname = null; - SequenceI sq = (SequenceI) ((SequenceNode) node).element(); + SequenceI sq = (SequenceI) ((BinaryNode) node).element(); if (sq != null) { // search dbrefs, features and annotation - DBRefEntry[] refs = jalview.util.DBRefUtils + List refs = jalview.util.DBRefUtils .selectRefs(sq.getDBRefs(), new String[] - { labelClass.toUpperCase() }); + { labelClass.toUpperCase(Locale.ROOT) }); if (refs != null) { - for (int i = 0; i < refs.length; i++) + for (int i = 0, ni = refs.size(); i < ni; i++) { if (newname == null) { - newname = new String(refs[i].getAccessionId()); + newname = new String(refs.get(i).getAccessionId()); } else { - newname = newname + "; " + refs[i].getAccessionId(); + newname += "; " + refs.get(i).getAccessionId(); } } } @@ -812,7 +833,7 @@ public class TreePanel extends GTreePanel { // String oldname = ((SequenceNode) node).getName(); // TODO : save oldname in the undo object for this modification. - ((SequenceNode) node).setName(newname); + ((BinaryNode) node).setName(newname); } } } @@ -838,8 +859,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(Locale.ROOT)); /* * short score model name (long description can be too long) @@ -849,8 +870,52 @@ public class TreePanel extends GTreePanel /* * put them together as Using */ - final String ttl = MessageManager.formatMessage("label.treecalc_title", + final String ttl = MessageManager.formatMessage("label.calc_title", 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) + { + jalview.bin.Console.errPrintln("Error writing tree as EPS"); + ex.printStackTrace(); + } + } + + public AlignViewport getViewport() + { + return av; + } + + public void setViewport(AlignViewport av) + { + this.av = av; + } + + public TreeCanvas getTreeCanvas() + { + return treeCanvas; + } }