in progress
[jalview.git] / forester / java / src / org / forester / archaeopteryx / MainFrame.java
index 377c999..ac9bd6d 100644 (file)
@@ -32,13 +32,14 @@ import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;\r
 import java.io.File;\r
 import java.io.IOException;\r
+import java.util.ArrayList;\r
 import java.util.LinkedList;\r
 import java.util.List;\r
 import java.util.Locale;\r
 import java.util.NoSuchElementException;\r
-import java.util.Set;\r
 \r
 import javax.swing.Box;\r
+import javax.swing.Icon;\r
 import javax.swing.JApplet;\r
 import javax.swing.JCheckBoxMenuItem;\r
 import javax.swing.JFrame;\r
@@ -67,6 +68,7 @@ import org.forester.phylogeny.PhylogenyNode.NH_CONVERSION_SUPPORT_VALUE_STYLE;
 import org.forester.phylogeny.data.Annotation;\r
 import org.forester.phylogeny.data.NodeVisualData.NodeFill;\r
 import org.forester.phylogeny.data.NodeVisualData.NodeShape;\r
+import org.forester.phylogeny.iterators.PhylogenyNodeIterator;\r
 import org.forester.sdi.GSDI;\r
 import org.forester.sdi.GSDIR;\r
 import org.forester.sdi.SDIException;\r
@@ -124,6 +126,8 @@ public abstract class MainFrame extends JFrame implements ActionListener {
     static final String         USE_BRACKETS_FOR_CONF_IN_NH_LABEL       = "Use Brackets for Confidence Values";\r
     static final String         USE_INTERNAL_NAMES_FOR_CONF_IN_NH_LABEL = "Use Internal Node Names for Confidence Values";\r
     static final String         SHOW_BASIC_TREE_INFORMATION_LABEL       = "Basic Tree Information";\r
+    static final String RIGHT_LINE_UP_DOMAINS = "Right-align Domain Architectures";\r
+    static final String LINE_UP_RENDERABLE_DATA = "Line Up Node Diagrams";\r
     JMenuBar                    _jmenubar;\r
     JMenu                       _file_jmenu;\r
     JMenu                       _tools_menu;\r
@@ -162,6 +166,8 @@ public abstract class MainFrame extends JFrame implements ActionListener {
     JMenuItem                   _annotate_item;\r
     JMenuItem                   _remove_branch_color_item;\r
     JMenuItem                   _remove_visual_styles_item;\r
+    JMenuItem                   _delete_selected_nodes_item;\r
+    JMenuItem                   _delete_not_selected_nodes_item;\r
     // font size menu:\r
     JMenuItem                   _super_tiny_fonts_item;\r
     JMenuItem                   _tiny_fonts_item;\r
@@ -195,6 +201,8 @@ public abstract class MainFrame extends JFrame implements ActionListener {
     JMenuItem                   _cycle_node_fill_mi;\r
     JMenuItem                   _choose_node_size_mi;\r
     JCheckBoxMenuItem           _show_confidence_stddev_cbmi;\r
+   JCheckBoxMenuItem _right_line_up_domains_cbmi;\r
+    JCheckBoxMenuItem _line_up_renderable_data_cbmi;\r
     // _  print\r
     JCheckBoxMenuItem           _graphics_export_visible_only_cbmi;\r
     JCheckBoxMenuItem           _antialias_print_cbmi;\r
@@ -320,6 +328,18 @@ public abstract class MainFrame extends JFrame implements ActionListener {
             }\r
             midpointRoot();\r
         }\r
+        else if ( o == _delete_selected_nodes_item ) {\r
+            if ( isSubtreeDisplayed() ) {\r
+                return;\r
+            }\r
+            deleteSelectedNodes( true );\r
+        }\r
+        else if ( o == _delete_not_selected_nodes_item ) {\r
+            if ( isSubtreeDisplayed() ) {\r
+                return;\r
+            }\r
+            deleteSelectedNodes( false );\r
+        }\r
         else if ( o == _annotate_item ) {\r
             annotateSequences();\r
         }\r
@@ -471,16 +491,30 @@ public abstract class MainFrame extends JFrame implements ActionListener {
                 getCurrentTreePanel().updateOvSizes();\r
             }\r
         }\r
+        else if ( o == _line_up_renderable_data_cbmi ) {\r
+            updateOptions( getOptions() );\r
+        }\r
+        else if ( o == _right_line_up_domains_cbmi ) {\r
+            updateOptions( getOptions() );\r
+        }\r
+        \r
+        \r
         else if ( ( o == _rectangular_type_cbmi ) || ( o == _triangular_type_cbmi ) || ( o == _curved_type_cbmi )\r
                 || ( o == _convex_type_cbmi ) || ( o == _euro_type_cbmi ) || ( o == _rounded_type_cbmi )\r
                 || ( o == _unrooted_type_cbmi ) || ( o == _circular_type_cbmi ) ) {\r
             typeChanged( o );\r
         }\r
+        \r
         else if ( o == _about_item ) {\r
             about();\r
         }\r
         else if ( o == _help_item ) {\r
-            help();\r
+            try {\r
+                AptxUtil.openWebsite( Constants.APTX_DOC_SITE, is_applet, applet );\r
+            }\r
+            catch ( final IOException e1 ) {\r
+                ForesterUtil.printErrorMessage( Constants.PRG_NAME, e1.toString() );\r
+            }\r
         }\r
         else if ( o == _website_item ) {\r
             try {\r
@@ -526,6 +560,93 @@ public abstract class MainFrame extends JFrame implements ActionListener {
         _contentpane.repaint();\r
     }\r
 \r
+    private void deleteSelectedNodes( boolean delete ) {\r
+        final Phylogeny phy = getMainPanel().getCurrentPhylogeny();\r
+        if ( phy == null || phy.getNumberOfExternalNodes() < 2 ) {\r
+            return;\r
+        }\r
+        List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();\r
+        if ( ( getCurrentTreePanel().getFoundNodes0() != null ) || ( getCurrentTreePanel().getFoundNodes1() != null ) ) {\r
+            final List<PhylogenyNode>  all_selected_nodes = getCurrentTreePanel().getFoundNodesAsListOfPhylogenyNodes();\r
+            for( final PhylogenyNode n : all_selected_nodes ) {\r
+                if ( n.isExternal() ) {\r
+                    nodes.add( n );\r
+                }\r
+            }\r
+        }\r
+        \r
+        String function = "Retain";\r
+        if ( delete ) {\r
+            function = "Delete";\r
+        }\r
+        if ( ( nodes == null ) || nodes.isEmpty() ) {\r
+            JOptionPane\r
+                    .showMessageDialog( this,\r
+                                        "Need to select external nodes, either via direct selection or via the \"Search\" function",\r
+                                        "No external nodes selected to " + function.toLowerCase(),\r
+                                        JOptionPane.ERROR_MESSAGE );\r
+            return;\r
+        }\r
+        final int todo = nodes.size();\r
+        final int ext = phy.getNumberOfExternalNodes();\r
+        int res = todo;\r
+        if ( delete ) {\r
+            res = ext - todo;\r
+        }\r
+        if ( res < 1 ) {\r
+            JOptionPane.showMessageDialog( this,\r
+                                           "Cannot delete all nodes",\r
+                                           "Attempt to delete all nodes ",\r
+                                           JOptionPane.ERROR_MESSAGE );\r
+            return;\r
+        }\r
+        final int result = JOptionPane.showConfirmDialog( null, function + " " + todo\r
+                + " external node(s), from a total of " + ext + " external nodes," + "\nresulting in tree with " + res\r
+                + " nodes?", function + " external nodes", JOptionPane.OK_CANCEL_OPTION );\r
+        if ( result == JOptionPane.OK_OPTION ) {\r
+            if ( !delete ) {\r
+                final List<PhylogenyNode> to_delete = new ArrayList<PhylogenyNode>();\r
+                for( final PhylogenyNodeIterator it = phy.iteratorExternalForward(); it.hasNext(); ) {\r
+                    final PhylogenyNode n = it.next();\r
+                    if ( !nodes.contains( n ) ) {\r
+                        to_delete.add( n );\r
+                    }\r
+                }\r
+                for( final PhylogenyNode n : to_delete ) {\r
+                    phy.deleteSubtree( n, true );\r
+                }\r
+            }\r
+            else {\r
+                for( final PhylogenyNode n : nodes ) {\r
+                    phy.deleteSubtree( n, true );\r
+                }\r
+            }\r
+            resetSearch();\r
+            getCurrentTreePanel().setNodeInPreorderToNull();\r
+            phy.externalNodesHaveChanged();\r
+            phy.clearHashIdToNodeMap();\r
+            phy.recalculateNumberOfExternalDescendants( true );\r
+            getCurrentTreePanel().resetNodeIdToDistToLeafMap();\r
+            getCurrentTreePanel().setEdited( true );\r
+            repaint();\r
+        }\r
+    }\r
+\r
+    void resetSearch() {\r
+        getMainPanel().getCurrentTreePanel().setFoundNodes0( null );\r
+        getMainPanel().getCurrentTreePanel().setFoundNodes1( null );\r
+        getMainPanel().getControlPanel().setSearchFoundCountsOnLabel0( 0 );\r
+        getMainPanel().getControlPanel().getSearchFoundCountsLabel0().setVisible( false );\r
+        getMainPanel().getControlPanel().getSearchTextField0().setText( "" );\r
+        getMainPanel().getControlPanel().getSearchResetButton0().setEnabled( false );\r
+        getMainPanel().getControlPanel().getSearchResetButton0().setVisible( false );\r
+        getMainPanel().getControlPanel().setSearchFoundCountsOnLabel1( 0 );\r
+        getMainPanel().getControlPanel().getSearchFoundCountsLabel1().setVisible( false );\r
+        getMainPanel().getControlPanel().getSearchTextField1().setText( "" );\r
+        getMainPanel().getControlPanel().getSearchResetButton1().setEnabled( false );\r
+        getMainPanel().getControlPanel().getSearchResetButton1().setVisible( false );\r
+    }\r
+\r
     public Configuration getConfiguration() {\r
         return _configuration;\r
     }\r
@@ -620,9 +741,10 @@ public abstract class MainFrame extends JFrame implements ActionListener {
 \r
     void buildHelpMenu() {\r
         _help_jmenu = createMenu( "Help", getConfiguration() );\r
-        _help_jmenu.add( _help_item = new JMenuItem( "Help" ) );\r
+        _help_jmenu.add( _help_item = new JMenuItem( "Documentation" ) );\r
+        _help_jmenu.addSeparator();\r
         _help_jmenu.add( _website_item = new JMenuItem( "Archaeopteryx Home" ) );\r
-        _aptx_ref_item = new JMenuItem( "Archaeopteryx Reference" );\r
+        _aptx_ref_item = new JMenuItem( "Archaeopteryx Reference" ); //TODO need to add this...\r
         _help_jmenu.add( _phyloxml_website_item = new JMenuItem( "phyloXML Home" ) );\r
         _help_jmenu.add( _phyloxml_ref_item = new JMenuItem( "phyloXML Reference" ) );\r
         _help_jmenu.addSeparator();\r
@@ -978,95 +1100,7 @@ public abstract class MainFrame extends JFrame implements ActionListener {
         return _species_tree;\r
     }\r
 \r
-    void help() {\r
-        final StringBuilder sb = new StringBuilder();\r
-        sb.append( "Display options\n" );\r
-        sb.append( "-------------------\n" );\r
-        sb.append( "Use the checkboxes to select types of information to display on the tree.\n\n" );\r
-        sb.append( "Clickable tree nodes\n" );\r
-        sb.append( "--------------------\n" );\r
-        sb.append( "Tree nodes can be clicked, the action is determined by the 'click on node to' menu\n" );\r
-        sb.append( "or by right clicking:\n" );\r
-        sb.append( "o  Display Node Data -- display information for a node\n" );\r
-        sb.append( "o  Collapse/Uncollapse -- collapse and uncollapse subtree from clicked node\n" );\r
-        sb.append( "o  Root/Reroot -- change tree root to clicked node\n" );\r
-        sb.append( "o  Sub/Super Tree -- toggle between subtree from clicked node and whole tree\n" );\r
-        sb.append( "o  Swap Descendants -- switch descendant on either side of clicked node\n" );\r
-        sb.append( "o  Colorize Subtree -- color a subtree\n" );\r
-        sb.append( "o  Open Sequence Web -- launch a web browser to display sequence information\n" );\r
-        sb.append( "o  Open Taxonomy Web -- launch a web browser to display taxonomy information\n" );\r
-        sb.append( "-  there may be additional choices depending on this particular setup\n\n" );\r
-        sb.append( "Right clicking on a node always displays the information of a node.\n\n" );\r
-        sb.append( "Zooming\n" );\r
-        sb.append( "---------\n" );\r
-        sb.append( "The mouse wheel and the plus and minus keys control zooming.\n" );\r
-        sb.append( "Mouse wheel+Ctrl changes the text size.\n" );\r
-        sb.append( "Mouse wheel+Shift controls zooming in vertical direction only.\n" );\r
-        sb.append( "Use the buttons on the control panel to zoom the tree in and out, horizontally or vertically.\n" );\r
-        sb.append( "The entire tree can be fitted into the window by clicking the \"F\" button, or by pressing F, Delete, or Home.\n" );\r
-        sb.append( "The up, down, left, and right keys can be used to move the visible part (if zoomed in).\n" );\r
-        sb.append( "Up, down, left, and right+Shift can be used to control zooming horizontally and vertically.\n" );\r
-        sb.append( "Plus and minus keys+Ctrl change the text size; F+Ctrl, Delete+Ctrl, or Home+Ctrl resets it.\n\n" );\r
-        sb.append( "Quick tree manipulation:\n" );\r
-        sb.append( "------------------------\n" );\r
-        sb.append( "Order Subtrees -- order the tree by branch length\n" );\r
-        sb.append( "Uncollapse All -- uncollapse any and all collapsed branches\n\n" );\r
-        sb.append( "Memory problems (Java heap space error)\n" );\r
-        sb.append( "---------------------------------------\n" );\r
-        sb.append( "Since the Java default memory allocation is quite small, it might by necessary (for trees\n" );\r
-        sb.append( "with more than approximately 5000 external nodes) to increase the memory which Java can use, with\n" );\r
-        sb.append( "the '-Xmx' Java command line option. For example:\n" );\r
-        sb.append( "java -Xmx1024m -cp path\\to\\forester.jar org.forester.archaeopteryx.Archaeopteryx\n\n" );\r
-        // + "General remarks\n"\r
-        // + "---------------\n"\r
-        // +\r
-        // "o  The application version permits copying to the clipboard \n"\r
-        // +\r
-        // "    in the \"View\"|\"View as ...\" frame (either by control-c or button press).\n"\r
-        // +\r
-        // "o  Changes made to a subtree affect this subtree and its subtrees,\n"\r
-        // + "    but not any of its parent tree(s).\n"\r
-        // +\r
-        // "o  Archaeopteryx tries to detect whether the numerical values in a NH tree\n"\r
-        // +\r
-        // "    are likely to be bootstrap values instead of branch length values.\n\n"\r
-        // +\r
-        // " Remarks regarding SDI (Speciation Duplication Inference):\n"\r
-        // +\r
-        // "o  Each external node of the gene tree (in display) needs to be associated with\n"\r
-        // +\r
-        // "    a species: either directly through the \"Species\" field, or the species\n"\r
-        // +\r
-        // "    is part of the sequence name in the form \"XXXX_SPECIES\"\n"\r
-        // +\r
-        // "    (e.g. \"ACON_DROME\" or \"ACON_DROME/123-4489\" which is also acceptable).\n"\r
-        // +\r
-        // "o  A species tree for each species of the gene tree needs to be loaded with\n"\r
-        // +\r
-        // "   \"SDI\"|\"Load species tree\" prior the SDI execution.\n"\r
-        // +\r
-        // "o  !External nodes of the gene tree associated with species not present in\n"\r
-        // +\r
-        // "    the species tree are REMOVED prior to SDI execution!\n"\r
-        // +\r
-        // "o  Both the gene tree and the species tree must be completely binary.\n"\r
-        // +\r
-        // "o  Duplications and speciations are a function of the position of the root.\n"\r
-        // +\r
-        // "    Hence, after each manual \"Root/Reroot\"ing some duplications will be\n"\r
-        // + "    incorrect and need to be inferred again\n"\r
-        // +\r
-        // "    with: \"SDI\"|\"SDI (Speciation Duplication Inference)\n\n"\r
-        sb.append( "phyloXML\n" );\r
-        sb.append( "-------------------\n" );\r
-        sb.append( "Reference: " + Constants.PHYLOXML_REFERENCE + "\n" );\r
-        sb.append( "Website: " + Constants.PHYLOXML_WEB_SITE + "\n" );\r
-        sb.append( "Version: " + ForesterConstants.PHYLO_XML_VERSION + "\n" );\r
-        sb.append( "\n" );\r
-        sb.append( "For more information: https://sites.google.com/site/cmzmasek/home/software/archaeopteryx\n" );\r
-        sb.append( "Email: " + Constants.AUTHOR_EMAIL + "\n\n" );\r
-        TextFrame.instantiate( sb.toString(), "Help", _textframes );\r
-    }\r
+    \r
 \r
     void initializeTypeMenu( final Options options ) {\r
         setTypeMenuToAllUnselected();\r
@@ -1384,6 +1418,14 @@ public abstract class MainFrame extends JFrame implements ActionListener {
         else if ( ( _circular_type_cbmi != null ) && _circular_type_cbmi.isSelected() ) {\r
             options.setPhylogenyGraphicsType( PHYLOGENY_GRAPHICS_TYPE.CIRCULAR );\r
         }\r
+        if ( ( _right_line_up_domains_cbmi != null ) && _right_line_up_domains_cbmi.isEnabled() ) {\r
+            options.setRightLineUpDomains( _right_line_up_domains_cbmi.isSelected() );\r
+        }\r
+        \r
+        \r
+        if ( ( _line_up_renderable_data_cbmi != null ) && _line_up_renderable_data_cbmi.isEnabled() ) {\r
+            options.setLineUpRendarableNodeData( _line_up_renderable_data_cbmi.isSelected() );\r
+        }\r
     }\r
 \r
     void updateTypeCheckboxes( final Options options, final Object o ) {\r
@@ -1426,7 +1468,11 @@ public abstract class MainFrame extends JFrame implements ActionListener {
 \r
     private void annotateSequences() {\r
         if ( getCurrentTreePanel() != null ) {\r
-            final Set<Long> nodes = getCurrentTreePanel().getFoundNodes0();\r
+            List<PhylogenyNode> nodes = null;\r
+            if ( ( getCurrentTreePanel().getFoundNodes0() != null )\r
+                    || ( getCurrentTreePanel().getFoundNodes1() != null ) ) {\r
+                nodes = getCurrentTreePanel().getFoundNodesAsListOfPhylogenyNodes();\r
+            }\r
             if ( ( nodes == null ) || nodes.isEmpty() ) {\r
                 JOptionPane\r
                         .showMessageDialog( this,\r
@@ -1475,8 +1521,7 @@ public abstract class MainFrame extends JFrame implements ActionListener {
                         desc = desc.replaceAll( "\\s+", " " );\r
                     }\r
                     if ( !ForesterUtil.isEmpty( ref ) || !ForesterUtil.isEmpty( desc ) ) {\r
-                        for( final Long id : nodes ) {\r
-                            final PhylogenyNode n = phy.getNode( id );\r
+                        for( final PhylogenyNode n : nodes ) {\r
                             ForesterUtil.ensurePresenceOfSequence( n );\r
                             final Annotation ann = ForesterUtil.isEmpty( ref ) ? new Annotation()\r
                                     : new Annotation( ref );\r
@@ -1581,7 +1626,7 @@ public abstract class MainFrame extends JFrame implements ActionListener {
      */\r
     static void about() {\r
         final StringBuffer about = new StringBuffer( "Archaeopteryx\nVersion " + Constants.VERSION + "\n" );\r
-        about.append( "Copyright (C) 2013 Christian M. Zmasek\n" );\r
+        about.append( "Copyright (C) 2014 Christian M Zmasek\n" );\r
         about.append( "All Rights Reserved\n" );\r
         about.append( "License: GNU Lesser General Public License (LGPL)\n" );\r
         about.append( "Last modified: " + Constants.PRG_DATE + "\n" );\r
@@ -1605,6 +1650,8 @@ public abstract class MainFrame extends JFrame implements ActionListener {
         about.append( Constants.PHYLOXML_REFERENCE_SHORT + "\n" );\r
         about.append( "For more information & download:\n" );\r
         about.append( Constants.APTX_WEB_SITE + "\n" );\r
+        about.append( "Documentation:\n" );\r
+        about.append( Constants.APTX_DOC_SITE + "\n" );\r
         about.append( "Comments: " + Constants.AUTHOR_EMAIL );\r
         JOptionPane.showMessageDialog( null, about, Constants.PRG_NAME, JOptionPane.PLAIN_MESSAGE );\r
     }\r