/*
- * Jalview - A Sequence Alignment Editor and Viewer
- * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
* of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
* You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
*/
package jalview.gui;
-import java.beans.*;
-import java.io.*;
-import java.util.*;
-import javax.imageio.*;
-
-import java.awt.*;
-import java.awt.event.*;
-import java.awt.image.*;
-import javax.swing.*;
-
-import org.jibble.epsgraphics.*;
-import jalview.analysis.*;
-import jalview.datamodel.*;
-import jalview.io.*;
-import jalview.jbgui.*;
+import java.awt.Font;
+import java.awt.Graphics;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+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;
+import jalview.analysis.TreeBuilder;
+import jalview.analysis.TreeModel;
+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.AlignmentI;
+import jalview.datamodel.AlignmentView;
+import jalview.datamodel.BinaryNode;
+import jalview.datamodel.DBRefEntry;
+import jalview.datamodel.HiddenColumns;
+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.jbgui.GTreePanel;
+import jalview.util.ImageMaker.TYPE;
+import jalview.util.MessageManager;
+import jalview.viewmodel.AlignmentViewport;
/**
* DOCUMENT ME!
- *
+ *
* @author $author$
* @version $Revision$
*/
-public class TreePanel
- extends GTreePanel
+public class TreePanel extends GTreePanel
{
- String type;
- String pwtype;
- TreeCanvas treeCanvas;
- NJTree tree;
- AlignViewport av;
+ String treeType;
- /**
- * Creates a new TreePanel object.
- *
- * @param av DOCUMENT ME!
- * @param seqVector DOCUMENT ME!
- * @param type DOCUMENT ME!
- * @param pwtype DOCUMENT ME!
- * @param s DOCUMENT ME!
- * @param e DOCUMENT ME!
- */
- public TreePanel(AlignmentPanel ap, String type, String pwtype)
- {
- super();
- initTreePanel(ap, type, pwtype, null, null);
+ String scoreModelName; // if tree computed
- // We know this tree has distances. JBPNote TODO: prolly should add this as a userdefined default
- // showDistances(true);
- }
+ String treeTitle; // if tree loaded
+
+ SimilarityParamsI similarityParams;
+
+ private TreeCanvas treeCanvas;
+
+ TreeModel tree;
+
+ private AlignViewport av;
/**
* Creates a new TreePanel object.
- *
- * @param av DOCUMENT ME!
- * @param seqVector DOCUMENT ME!
- * @param newtree DOCUMENT ME!
- * @param type DOCUMENT ME!
- * @param pwtype DOCUMENT ME!
+ *
+ * @param ap
+ * @param type
+ * @param modelName
+ * @param options
*/
- public TreePanel(AlignmentPanel ap,
- String type,
- String pwtype,
- NewickFile newtree)
+ public TreePanel(AlignmentPanel ap, String type, String modelName,
+ SimilarityParamsI options)
{
super();
- initTreePanel(ap, type, pwtype, newtree, null);
+ this.setFrameIcon(null);
+ this.similarityParams = options;
+ initTreePanel(ap, type, modelName, null, null);
+
+ // We know this tree has distances. JBPNote TODO: prolly should add this as
+ // a userdefined default
+ // showDistances(true);
}
- public TreePanel(AlignmentPanel av,
- String type,
- String pwtype,
- NewickFile newtree, AlignmentView inputData)
+ public TreePanel(AlignmentPanel alignPanel, NewickFile newtree,
+ String theTitle, AlignmentView inputData)
{
super();
- initTreePanel(av, type, pwtype, newtree, inputData);
+ this.setFrameIcon(null);
+ this.treeTitle = theTitle;
+ initTreePanel(alignPanel, null, null, newtree, inputData);
}
public AlignmentI getAlignment()
{
- return treeCanvas.av.getAlignment();
+ return getTreeCanvas().getViewport().getAlignment();
}
- public AlignViewport getViewPort()
+ 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 pwtype,
- NewickFile newTree, AlignmentView inputData)
+ void initTreePanel(AlignmentPanel ap, String type, String modelName,
+ NewickFile newTree, AlignmentView inputData)
{
av = ap.av;
- this.type = type;
- this.pwtype = pwtype;
+ this.treeType = type;
+ this.scoreModelName = modelName;
treeCanvas = new TreeCanvas(this, ap, scrollPane);
scrollPane.setViewportView(treeCanvas);
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)
{
if (evt.getPropertyName().equals("alignment"))
if (tree == null)
{
System.out.println("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.
+ return;
}
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( (Vector) evt.getNewValue());
- treeCanvas.nameHash.clear(); // reset the mapping between canvas rectangles and leafnodes
+ tree.updatePlaceHolders((List<SequenceI>) evt.getNewValue());
+ treeCanvas.nameHash.clear(); // reset the mapping between canvas
+ // rectangles and leafnodes
repaint();
}
}
- });
-
- TreeLoader tl = new TreeLoader(newTree);
- if (inputData != null)
- {
- tl.odata = inputData;
- }
- tl.start();
-
+ };
+ av.addPropertyChangeListener(listener);
+ return listener;
}
+ @Override
public void viewMenu_menuSelected()
{
buildAssociatedViewMenu();
void buildAssociatedViewMenu()
{
- AlignmentPanel[] aps = PaintRefresher.getAssociatedPanels(av.
- getSequenceSetId());
- if (aps.length == 1 && treeCanvas.ap == aps[0])
+ AlignmentPanel[] aps = PaintRefresher
+ .getAssociatedPanels(av.getSequenceSetId());
+ if (aps.length == 1 && getTreeCanvas().getAssociatedPanel() == aps[0])
{
associateLeavesMenu.setVisible(false);
return;
associateLeavesMenu.setVisible(true);
- if ( (viewMenu.getItem(viewMenu.getItemCount() - 2) instanceof JMenuItem))
+ if ((viewMenu
+ .getItem(viewMenu.getItemCount() - 2) instanceof JMenuItem))
{
viewMenu.insertSeparator(viewMenu.getItemCount() - 1);
}
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()
{
+ @Override
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());
}
});
associateLeavesMenu.add(item);
}
- final JRadioButtonMenuItem itemf = new JRadioButtonMenuItem("All Views");
+ final JRadioButtonMenuItem itemf = new JRadioButtonMenuItem(
+ MessageManager.getString("label.all_views"));
buttonGroup.add(itemf);
itemf.setSelected(treeCanvas.applyToAllViews);
itemf.addActionListener(new ActionListener()
{
+ @Override
public void actionPerformed(ActionEvent evt)
{
treeCanvas.applyToAllViews = itemf.isSelected();
}
- class TreeLoader
- extends Thread
+ class TreeLoader extends Thread
{
- NewickFile newtree;
- jalview.datamodel.AlignmentView odata = null;
- public TreeLoader(NewickFile newtree)
+ private NewickFile newtree;
+
+ private AlignmentView odata = null;
+
+ public TreeLoader(NewickFile newickFile, AlignmentView inputData)
{
- this.newtree = newtree;
- if (newtree != null)
+ this.newtree = newickFile;
+ this.odata = inputData;
+
+ if (newickFile != null)
{
// Must be outside run(), as Jalview2XML tries to
// update distance/bootstrap visibility at the same time
- showBootstrap(newtree.HasBootstrap());
- showDistances(newtree.HasDistances());
+ showBootstrap(newickFile.HasBootstrap());
+ showDistances(newickFile.HasDistances());
}
}
+ @Override
public void run()
{
if (newtree != null)
{
- if (odata == null)
- {
- tree = new NJTree(av.alignment.getSequencesArray(),
- newtree);
- }
- else
+ tree = new TreeModel(av.getAlignment().getSequencesArray(), odata,
+ newtree);
+ if (tree.getOriginalData() == null)
{
- tree = new NJTree(av.alignment.getSequencesArray(), odata, newtree);
- }
- if (!tree.hasOriginalSequenceData())
- {
- allowOriginalSeqData(false);
+ originalSeqData.setVisible(false);
}
}
else
{
- int start, end;
- SequenceI[] seqs;
- AlignmentView seqStrings = av.getAlignmentView(av.getSelectionGroup() != null);
- if (av.getSelectionGroup() == null)
- {
- start = 0;
- end = av.alignment.getWidth();
- seqs = av.alignment.getSequencesArray();
- }
- else
- {
- start = av.getSelectionGroup().getStartRes();
- end = av.getSelectionGroup().getEndRes() + 1;
- seqs = av.getSelectionGroup().getSequencesInOrder(av.alignment);
- }
-
- tree = new NJTree(seqs, seqStrings, type, pwtype, start, end);
+ 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);
}
treeCanvas.setTree(tree);
treeCanvas.repaint();
av.setCurrentTree(tree);
-
+ if (av.getSortByTree())
+ {
+ sortByTree_actionPerformed();
+ }
}
}
treeCanvas.setMarkPlaceholders(b);
}
- private void allowOriginalSeqData(boolean b)
- {
- originalSeqData.setVisible(b);
- }
-
/**
* DOCUMENT ME!
- *
+ *
* @return DOCUMENT ME!
*/
- public NJTree getTree()
+ public TreeModel getTree()
{
return tree;
}
/**
* DOCUMENT ME!
- *
- * @param e DOCUMENT ME!
+ *
+ * @param e
+ * DOCUMENT ME!
*/
+ @Override
public void textbox_actionPerformed(ActionEvent e)
{
CutAndPasteTransfer cap = new CutAndPasteTransfer();
- StringBuffer buffer = new StringBuffer();
-
- if (type.equals("AV"))
- {
- buffer.append("Average distance tree using ");
- }
- else
- {
- buffer.append("Neighbour joining tree using ");
- }
+ String newTitle = getPanelTitle();
- if (pwtype.equals("BL"))
+ NewickFile fout = new NewickFile(tree.getTopNode());
+ try
{
- buffer.append("BLOSUM62");
- }
- else
+ cap.setText(fout.print(tree.hasBootstrap(), tree.hasDistances(),
+ tree.hasRootDistance()));
+ Desktop.addInternalFrame(cap, newTitle, 500, 100);
+ } catch (OutOfMemoryError oom)
{
- buffer.append("PID");
+ new OOMWarning("generating newick tree file", oom);
+ cap.dispose();
}
- Desktop.addInternalFrame(cap, buffer.toString(), 500, 100);
-
- jalview.io.NewickFile fout = new jalview.io.NewickFile(tree.getTopNode());
- cap.setText(fout.print(tree.isHasBootstrap(), tree.isHasDistances(),
- tree.isHasRootDistance()));
}
/**
* DOCUMENT ME!
- *
- * @param e DOCUMENT ME!
+ *
+ * @param e
+ * DOCUMENT ME!
*/
+ @Override
public void saveAsNewick_actionPerformed(ActionEvent e)
{
- JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache.
- getProperty(
- "LAST_DIRECTORY"));
+ // TODO: JAL-3048 save newick file for Jalview-JS
+ JalviewFileChooser chooser = new JalviewFileChooser(
+ Cache.getProperty("LAST_DIRECTORY"));
chooser.setFileView(new JalviewFileView());
- chooser.setDialogTitle("Save tree as newick file");
- chooser.setToolTipText("Save");
+ chooser.setDialogTitle(
+ MessageManager.getString("label.save_tree_as_newick"));
+ chooser.setToolTipText(MessageManager.getString("action.save"));
int value = chooser.showSaveDialog(null);
if (value == JalviewFileChooser.APPROVE_OPTION)
{
String choice = chooser.getSelectedFile().getPath();
- jalview.bin.Cache.setProperty("LAST_DIRECTORY",
- chooser.getSelectedFile().getParent());
+ Cache.setProperty("LAST_DIRECTORY",
+ chooser.getSelectedFile().getParent());
try
{
- jalview.io.NewickFile fout = new jalview.io.NewickFile(tree.getTopNode());
- String output = fout.print(tree.isHasBootstrap(), tree.isHasDistances(),
- tree.isHasRootDistance());
- java.io.PrintWriter out = new java.io.PrintWriter(new java.io.
- FileWriter(
- choice));
+ jalview.io.NewickFile fout = new jalview.io.NewickFile(
+ tree.getTopNode());
+ 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);
out.close();
- }
- catch (Exception ex)
+ } catch (Exception ex)
{
ex.printStackTrace();
}
/**
* DOCUMENT ME!
- *
- * @param e DOCUMENT ME!
+ *
+ * @param e
+ * DOCUMENT ME!
*/
+ @Override
public void printMenu_actionPerformed(ActionEvent e)
{
- //Putting in a thread avoids Swing painting problems
+ // Putting in a thread avoids Swing painting problems
treeCanvas.startPrinting();
}
+ @Override
public void originalSeqData_actionPerformed(ActionEvent e)
{
- if (!tree.hasOriginalSequenceData())
+ AlignmentView originalData = tree.getOriginalData();
+ if (originalData == null)
{
- jalview.bin.Cache.log.info("Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action.");
+ Console.info(
+ "Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action.");
return;
}
- // decide if av alignment is sufficiently different to original data to warrant a new window to be created
- // create new alignmnt window with hidden regions (unhiding hidden regions yields unaligned seqs)
+ // decide if av alignment is sufficiently different to original data to
+ // warrant a new window to be created
+ // create new alignmnt window with hidden regions (unhiding hidden regions
+ // yields unaligned seqs)
// or create a selection box around columns in alignment view
// test Alignment(SeqCigar[])
- Object[] alAndColsel = tree.seqData.getAlignmentAndColumnSelection(av.
- getGapCharacter());
+ char gc = '-';
+ try
+ {
+ // we try to get the associated view's gap character
+ // but this may fail if the view was closed...
+ gc = av.getGapCharacter();
+
+ } catch (Exception ex)
+ {
+ }
+
+ Object[] alAndColsel = originalData.getAlignmentAndHiddenColumns(gc);
if (alAndColsel != null && alAndColsel[0] != null)
{
// AlignmentOrder origorder = new AlignmentOrder(alAndColsel[0]);
- Alignment al = new Alignment( (SequenceI[]) alAndColsel[0]);
- Alignment dataset = av.getAlignment().getDataset();
+ AlignmentI al = new Alignment((SequenceI[]) alAndColsel[0]);
+ AlignmentI dataset = (av != null && av.getAlignment() != null)
+ ? av.getAlignment().getDataset()
+ : null;
if (dataset != null)
{
al.setDataset(dataset);
if (true)
{
// make a new frame!
- AlignFrame af = new AlignFrame(al, (ColumnSelection) alAndColsel[1],
- AlignFrame.DEFAULT_WIDTH,
- AlignFrame.DEFAULT_HEIGHT
- );
+ AlignFrame af = new AlignFrame(al, (HiddenColumns) alAndColsel[1],
+ AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
- //>>>This is a fix for the moment, until a better solution is found!!<<<
+ // >>>This is a fix for the moment, until a better solution is
+ // found!!<<<
// af.getFeatureRenderer().transferSettings(alignFrame.getFeatureRenderer());
- // af.addSortByOrderMenuItem(ServiceName + " Ordering",
- // msaorder);
+ // af.addSortByOrderMenuItem(ServiceName + " Ordering",
+ // msaorder);
- Desktop.addInternalFrame(af, "Original Data for " + this.title,
- AlignFrame.DEFAULT_WIDTH,
- AlignFrame.DEFAULT_HEIGHT);
+ Desktop.addInternalFrame(af, MessageManager.formatMessage(
+ "label.original_data_for_params", new Object[]
+ { this.title }), AlignFrame.DEFAULT_WIDTH,
+ AlignFrame.DEFAULT_HEIGHT);
}
}
}
/**
* DOCUMENT ME!
- *
- * @param e DOCUMENT ME!
+ *
+ * @param e
+ * DOCUMENT ME!
*/
+ @Override
public void fitToWindow_actionPerformed(ActionEvent e)
{
treeCanvas.fitToWindow = fitToWindow.isSelected();
}
/**
+ * sort the associated alignment view by the current tree.
+ *
+ * @param e
+ */
+ @Override
+ public void sortByTree_actionPerformed()
+ {
+
+ if (treeCanvas.applyToAllViews)
+ {
+ final ArrayList<CommandI> commands = new ArrayList<>();
+ for (AlignmentPanel ap : PaintRefresher
+ .getAssociatedPanels(av.getSequenceSetId()))
+ {
+ commands.add(sortAlignmentIn(ap.av.getAlignPanel()));
+ }
+ av.getAlignPanel().alignFrame.addHistoryItem(new CommandI()
+ {
+
+ @Override
+ public void undoCommand(AlignmentI[] views)
+ {
+ for (CommandI tsort : commands)
+ {
+ tsort.undoCommand(views);
+ }
+ }
+
+ @Override
+ public int getSize()
+ {
+ return commands.size();
+ }
+
+ @Override
+ public String getDescription()
+ {
+ return "Tree Sort (many views)";
+ }
+
+ @Override
+ public void doCommand(AlignmentI[] views)
+ {
+
+ for (CommandI tsort : commands)
+ {
+ tsort.doCommand(views);
+ }
+ }
+ });
+ for (AlignmentPanel ap : PaintRefresher
+ .getAssociatedPanels(av.getSequenceSetId()))
+ {
+ // ensure all the alignFrames refresh their GI after adding an undo item
+ ap.alignFrame.updateEditMenuBar();
+ }
+ }
+ else
+ {
+ 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, false);
+ return undo;
+ }
+
+ /**
* DOCUMENT ME!
- *
- * @param e DOCUMENT ME!
+ *
+ * @param e
+ * DOCUMENT ME!
*/
+ @Override
public void font_actionPerformed(ActionEvent e)
{
if (treeCanvas == null)
return treeCanvas.font;
}
- public void setTreeFont(Font font)
+ public void setTreeFont(Font f)
{
if (treeCanvas != null)
{
- treeCanvas.setFont(font);
+ treeCanvas.setFont(f);
}
}
/**
* DOCUMENT ME!
- *
- * @param e DOCUMENT ME!
+ *
+ * @param e
+ * DOCUMENT ME!
*/
+ @Override
public void distanceMenu_actionPerformed(ActionEvent e)
{
treeCanvas.setShowDistances(distanceMenu.isSelected());
/**
* DOCUMENT ME!
- *
- * @param e DOCUMENT ME!
+ *
+ * @param e
+ * DOCUMENT ME!
*/
+ @Override
public void bootstrapMenu_actionPerformed(ActionEvent e)
{
treeCanvas.setShowBootstrap(bootstrapMenu.isSelected());
/**
* DOCUMENT ME!
- *
- * @param e DOCUMENT ME!
+ *
+ * @param e
+ * DOCUMENT ME!
*/
+ @Override
public void placeholdersMenu_actionPerformed(ActionEvent e)
{
treeCanvas.setMarkPlaceholders(placeholdersMenu.isSelected());
}
/**
- * 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.
*/
- public void epsTree_actionPerformed(ActionEvent e)
+ @Override
+ public void writeTreeImage(TYPE imageFormat)
{
- boolean accurateText = true;
-
- String renderStyle = jalview.bin.Cache.getDefault("EPS_RENDERING",
- "Prompt each time");
+ int width = treeCanvas.getWidth();
+ int height = treeCanvas.getHeight();
+ ImageWriterI writer = new ImageWriterI()
+ {
+ @Override
+ public void exportImage(Graphics g) throws Exception
+ {
+ treeCanvas.draw(g, width, height);
+ }
+ };
+ String tree = MessageManager.getString("label.tree");
+ ImageExporter exporter = new ImageExporter(writer, null, imageFormat,
+ tree);
+ exporter.doExport(null, this, width, height,
+ tree.toLowerCase(Locale.ROOT));
+ }
- // 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")))
+ /**
+ * change node labels to the annotation referred to by labelClass TODO:
+ * promote to a datamodel modification that can be undone TODO: make argument
+ * one case of a generic transformation function ie { undoStep = apply(Tree,
+ * TransformFunction)};
+ *
+ * @param labelClass
+ */
+ public void changeNames(final String labelClass)
+ {
+ tree.applyToNodes(new NodeTransformI()
{
- EPSOptions eps = new EPSOptions();
- renderStyle = eps.getValue();
- if (renderStyle == null || eps.cancelled)
+ @Override
+ public void transform(BinaryNode node)
{
- return;
+ if (node instanceof SequenceNode
+ && !((SequenceNode) node).isPlaceholder()
+ && !((SequenceNode) node).isDummy())
+ {
+ String newname = null;
+ SequenceI sq = (SequenceI) ((BinaryNode) node).element();
+ if (sq != null)
+ {
+ // search dbrefs, features and annotation
+ List<DBRefEntry> refs = jalview.util.DBRefUtils
+ .selectRefs(sq.getDBRefs(), new String[]
+ { labelClass.toUpperCase(Locale.ROOT) });
+ if (refs != null)
+ {
+ for (int i = 0, ni = refs.size(); i < ni; i++)
+ {
+ if (newname == null)
+ {
+ newname = new String(refs.get(i).getAccessionId());
+ }
+ else
+ {
+ newname += "; " + refs.get(i).getAccessionId();
+ }
+ }
+ }
+ if (newname == null)
+ {
+ List<SequenceFeature> features = sq.getFeatures()
+ .getPositionalFeatures(labelClass);
+ for (SequenceFeature feature : features)
+ {
+ if (newname == null)
+ {
+ newname = feature.getDescription();
+ }
+ else
+ {
+ newname = newname + "; " + feature.getDescription();
+ }
+ }
+ }
+ }
+ if (newname != null)
+ {
+ // String oldname = ((SequenceNode) node).getName();
+ // TODO : save oldname in the undo object for this modification.
+ ((BinaryNode) node).setName(newname);
+ }
+ }
}
+ });
+ }
- }
-
- if (renderStyle.equalsIgnoreCase("text"))
+ /**
+ * Formats a localised title for the tree panel, like
+ * <p>
+ * Neighbour Joining Using BLOSUM62
+ * <p>
+ * For a tree loaded from file, just uses the file name
+ *
+ * @return
+ */
+ public String getPanelTitle()
+ {
+ if (treeTitle != null)
{
- accurateText = false;
+ return treeTitle;
}
- int width = treeCanvas.getWidth();
- int height = treeCanvas.getHeight();
+ /*
+ * i18n description of Neighbour Joining or Average Distance method
+ */
+ String treecalcnm = MessageManager.getString(
+ "label.tree_calc_" + treeType.toLowerCase(Locale.ROOT));
+
+ /*
+ * short score model name (long description can be too long)
+ */
+ String smn = scoreModelName;
+
+ /*
+ * put them together as <method> Using <model>
+ */
+ 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
{
- jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(
- jalview.bin.Cache.getProperty(
- "LAST_DIRECTORY"), new String[]
- {"eps"},
- new String[]
- {"Encapsulated Postscript"},
- "Encapsulated Postscript");
- chooser.setFileView(new jalview.io.JalviewFileView());
- chooser.setDialogTitle("Create EPS file from tree");
- chooser.setToolTipText("Save");
-
- int value = chooser.showSaveDialog(this);
-
- if (value != jalview.io.JalviewFileChooser.APPROVE_OPTION)
- {
- return;
- }
-
- jalview.bin.Cache.setProperty("LAST_DIRECTORY",
- chooser.getSelectedFile().getParent());
+ int width = treeCanvas.getWidth();
+ int height = treeCanvas.getHeight();
- FileOutputStream out = new FileOutputStream(chooser.getSelectedFile());
+ FileOutputStream out = new FileOutputStream(outFile);
EpsGraphics2D pg = new EpsGraphics2D("Tree", out, 0, 0, width,
- height);
-
- pg.setAccurateTextMode(accurateText);
-
+ height);
+ pg.setAccurateTextMode(!textOption);
treeCanvas.draw(pg, width, height);
pg.flush();
pg.close();
- }
- catch (Exception ex)
+ } catch (Exception ex)
{
+ System.err.println("Error writing tree as EPS");
ex.printStackTrace();
}
}
- /**
- * DOCUMENT ME!
- *
- * @param e DOCUMENT ME!
- */
- public void pngTree_actionPerformed(ActionEvent e)
+ public AlignViewport getViewport()
{
- int width = treeCanvas.getWidth();
- int height = treeCanvas.getHeight();
-
- try
- {
- jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(
- jalview.bin.Cache.getProperty(
- "LAST_DIRECTORY"), new String[]
- {"png"},
- new String[]
- {"Portable network graphics"},
- "Portable network graphics");
-
- chooser.setFileView(new jalview.io.JalviewFileView());
- chooser.setDialogTitle("Create PNG image from tree");
- chooser.setToolTipText("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();
+ return av;
+ }
- treeCanvas.draw(png, width, height);
+ public void setViewport(AlignViewport av)
+ {
+ this.av = av;
+ }
- ImageIO.write(bi, "png", out);
- out.close();
- }
- catch (Exception ex)
- {
- ex.printStackTrace();
- }
+ public TreeCanvas getTreeCanvas()
+ {
+ return treeCanvas;
}
}