2 // FORESTER -- software libraries and applications
3 // for evolutionary biology research and applications.
5 // Copyright (C) 2008-2009 Christian M. Zmasek
6 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
7 // Copyright (C) 2000-2001 Washington University School of Medicine
8 // and Howard Hughes Medical Institute
9 // Copyright (C) 2003-2007 Ethalinda K.S. Cannon
10 // All rights reserved
12 // This library is free software; you can redistribute it and/or
13 // modify it under the terms of the GNU Lesser General Public
14 // License as published by the Free Software Foundation; either
15 // version 2.1 of the License, or (at your option) any later version.
17 // This library is distributed in the hope that it will be useful,
18 // but WITHOUT ANY WARRANTY; without even the implied warranty of
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 // Lesser General Public License for more details.
22 // You should have received a copy of the GNU Lesser General Public
23 // License along with this library; if not, write to the Free Software
24 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
26 // Contact: phylosoft @ gmail . com
27 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
29 package org.forester.archaeopteryx;
31 import java.awt.BorderLayout;
32 import java.awt.event.ComponentAdapter;
33 import java.awt.event.ComponentEvent;
34 import java.awt.event.WindowAdapter;
35 import java.awt.event.WindowEvent;
36 import java.io.FileNotFoundException;
37 import java.io.IOException;
38 import java.net.MalformedURLException;
41 import javax.swing.ButtonGroup;
42 import javax.swing.JApplet;
43 import javax.swing.JCheckBoxMenuItem;
44 import javax.swing.JMenuBar;
45 import javax.swing.JMenuItem;
46 import javax.swing.JRadioButtonMenuItem;
47 import javax.swing.event.ChangeEvent;
48 import javax.swing.event.ChangeListener;
50 import org.forester.archaeopteryx.Options.CLADOGRAM_TYPE;
51 import org.forester.archaeopteryx.Options.NODE_LABEL_DIRECTION;
52 import org.forester.io.parsers.nhx.NHXParser.TAXONOMY_EXTRACTION;
53 import org.forester.phylogeny.Phylogeny;
54 import org.forester.util.ForesterUtil;
56 public final class MainFrameApplet extends MainFrame {
58 private static final long serialVersionUID = 1941019292746717053L;
59 private final static int DEFAULT_FRAME_X_SIZE = 640;
60 private final static int DEFAULT_FRAME_Y_SIZE = 580;
61 private final ArchaeopteryxA _applet;
62 private ButtonGroup _radio_group_1;
64 MainFrameApplet( final ArchaeopteryxA parent_applet,
65 final Configuration configuration,
66 final String species_tree_url_str ) {
67 setTitle( ArchaeopteryxA.NAME );
68 _applet = parent_applet;
69 setConfiguration( configuration );
70 setOptions( Options.createInstance( configuration ) );
71 _mainpanel = new MainPanelApplets( _configuration, this );
72 if ( !ForesterUtil.isEmpty( species_tree_url_str ) ) {
74 readSpeciesTree( configuration, species_tree_url_str );
76 catch ( final Exception e ) {
77 ForesterUtil.printErrorMessage( ArchaeopteryxA.NAME, "failed to read species tree from "
78 + species_tree_url_str );
79 ForesterUtil.printErrorMessage( ArchaeopteryxA.NAME, e.toString() );
83 _jmenubar = new JMenuBar();
84 if ( !_configuration.isUseNativeUI() ) {
85 _jmenubar.setBackground( _configuration.getGuiMenuBackgroundColor() );
87 if ( getSpeciesTree() != null ) {
97 setJMenuBar( _jmenubar );
98 _contentpane = getContentPane();
99 _contentpane.setLayout( new BorderLayout() );
100 _contentpane.add( _mainpanel, BorderLayout.CENTER );
101 setSize( getConfiguration().getFrameXSize() > 40 ? getConfiguration().getFrameXSize() : DEFAULT_FRAME_X_SIZE,
102 getConfiguration().getFrameYSize() > 40 ? getConfiguration().getFrameYSize() : DEFAULT_FRAME_Y_SIZE );
103 addWindowListener( new WindowAdapter() {
106 public void windowClosing( final WindowEvent e ) {
110 addComponentListener( new ComponentAdapter() {
113 public void componentResized( final ComponentEvent e ) {
114 if ( _mainpanel.getCurrentTreePanel() != null ) {
115 _mainpanel.getCurrentTreePanel().calcParametersForPainting( _mainpanel.getCurrentTreePanel()
117 _mainpanel.getCurrentTreePanel()
122 setFocusable( true );
124 requestFocusInWindow();
129 void buildAnalysisMenu() {
130 _analysis_menu = MainFrame.createMenu( "Analysis", getConfiguration() );
131 _analysis_menu.add( _gsdi_item = new JMenuItem( "GSDI (Generalized Speciation Duplication Inference)" ) );
132 _analysis_menu.add( _gsdir_item = new JMenuItem( "GSDIR (GSDI with re-rooting)" ) );
133 customizeJMenuItem( _gsdi_item );
134 customizeJMenuItem( _gsdir_item );
135 // _analysis_menu.addSeparator();
136 // _analysis_menu.add( _lineage_inference = new JMenuItem( INFER_ANCESTOR_TAXONOMIES ) );
137 // customizeJMenuItem( _lineage_inference );
138 // _lineage_inference.setToolTipText( "Inference of ancestor taxonomies/lineages" );
139 _jmenubar.add( _analysis_menu );
142 void buildOptionsMenu() {
143 _options_jmenu = MainFrame.createMenu( MainFrame.OPTIONS_HEADER, getConfiguration() );
144 _options_jmenu.addChangeListener( new ChangeListener() {
147 public void stateChanged( final ChangeEvent e ) {
148 MainFrame.setOvPlacementColorChooseMenuItem( _overview_placment_mi, getOptions() );
149 MainFrame.setTextColorChooseMenuItem( _switch_colors_mi, getCurrentTreePanel() );
151 .setTextMinSupportMenuItem( _choose_minimal_confidence_mi, getOptions(), getCurrentTreePanel() );
152 MainFrame.setTextForFontChooserMenuItem( _choose_font_mi, createCurrentFontDesc( getMainPanel()
153 .getTreeFontSet() ) );
154 setTextForGraphicsSizeChooserMenuItem( _print_size_mi, getOptions() );
155 setTextForPdfLineWidthChooserMenuItem( _choose_pdf_width_mi, getOptions() );
156 MainFrame.setCycleNodeFillMenuItem( _cycle_node_fill_mi, getOptions() );
157 MainFrame.setCycleNodeShapeMenuItem( _cycle_node_shape_mi, getOptions() );
158 MainFrame.setTextNodeSizeMenuItem( _choose_node_size_mi, getOptions() );
160 getMainPanel().getControlPanel().setVisibilityOfDomainStrucureCB();
161 getMainPanel().getControlPanel().setVisibilityOfX();
163 catch ( final Exception ignore ) {
164 // do nothing, not important.
168 _options_jmenu.add( MainFrame.customizeMenuItemAsLabel( new JMenuItem( MainFrame.DISPLAY_SUBHEADER ),
169 getConfiguration() ) );
171 .add( _ext_node_dependent_cladogram_rbmi = new JRadioButtonMenuItem( MainFrame.NONUNIFORM_CLADOGRAMS_LABEL ) );
172 _options_jmenu.add( _uniform_cladograms_rbmi = new JRadioButtonMenuItem( MainFrame.UNIFORM_CLADOGRAMS_LABEL ) );
173 _options_jmenu.add( _non_lined_up_cladograms_rbmi = new JRadioButtonMenuItem( NON_LINED_UP_CLADOGRAMS_LABEL ) );
174 _radio_group_1 = new ButtonGroup();
175 _radio_group_1.add( _ext_node_dependent_cladogram_rbmi );
176 _radio_group_1.add( _uniform_cladograms_rbmi );
177 _radio_group_1.add( _non_lined_up_cladograms_rbmi );
178 _options_jmenu.add( _show_overview_cbmi = new JCheckBoxMenuItem( MainFrame.SHOW_OVERVIEW_LABEL ) );
179 _options_jmenu.add( _show_scale_cbmi = new JCheckBoxMenuItem( MainFrame.DISPLAY_SCALE_LABEL ) );
181 .add( _show_default_node_shapes_internal_cbmi = new JCheckBoxMenuItem( MainFrame.DISPLAY_NODE_BOXES_LABEL_INT ) );
183 .add( _show_default_node_shapes_external_cbmi = new JCheckBoxMenuItem( MainFrame.DISPLAY_NODE_BOXES_LABEL_EXT ) );
185 .add( _show_default_node_shapes_for_marked_cbmi = new JCheckBoxMenuItem( MainFrame.DISPLAY_NODE_BOXES_LABEL_MARKED ) );
186 _options_jmenu.add( _line_up_renderable_data_cbmi = new JCheckBoxMenuItem( MainFrame.LINE_UP_RENDERABLE_DATA ) );
187 if ( getConfiguration().doDisplayOption( Configuration.show_domain_architectures ) ) {
188 _options_jmenu.add( _right_line_up_domains_cbmi = new JCheckBoxMenuItem( MainFrame.RIGHT_LINE_UP_DOMAINS ) );
189 _options_jmenu.add( _show_domain_labels = new JCheckBoxMenuItem( MainFrame.SHOW_DOMAIN_LABELS_LABEL ) );
191 _options_jmenu.add( _show_annotation_ref_source = new JCheckBoxMenuItem( MainFrame.SHOW_ANN_REF_SOURCE_LABEL ) );
192 _options_jmenu.add( _show_confidence_stddev_cbmi = new JCheckBoxMenuItem( MainFrame.SHOW_CONF_STDDEV_LABEL ) );
194 .add( _color_by_taxonomic_group_cbmi = new JCheckBoxMenuItem( MainFrame.COLOR_BY_TAXONOMIC_GROUP ) );
196 .add( _color_labels_same_as_parent_branch = new JCheckBoxMenuItem( MainFrame.COLOR_LABELS_LABEL ) );
197 _color_labels_same_as_parent_branch.setToolTipText( MainFrame.COLOR_LABELS_TIP );
198 _options_jmenu.add( _abbreviate_scientific_names = new JCheckBoxMenuItem( MainFrame.ABBREV_SN_LABEL ) );
199 _options_jmenu.add( _label_direction_cbmi = new JCheckBoxMenuItem( MainFrame.LABEL_DIRECTION_LABEL ) );
200 _label_direction_cbmi.setToolTipText( MainFrame.LABEL_DIRECTION_TIP );
201 _options_jmenu.add( _screen_antialias_cbmi = new JCheckBoxMenuItem( MainFrame.SCREEN_ANTIALIAS_LABEL ) );
202 _options_jmenu.add( _background_gradient_cbmi = new JCheckBoxMenuItem( MainFrame.BG_GRAD_LABEL ) );
203 _options_jmenu.add( _cycle_node_shape_mi = new JMenuItem( MainFrame.CYCLE_NODE_SHAPE_LABEL ) );
204 _options_jmenu.add( _cycle_node_fill_mi = new JMenuItem( MainFrame.CYCLE_NODE_FILL_LABEL ) );
205 _options_jmenu.add( _choose_node_size_mi = new JMenuItem( MainFrame.CHOOSE_NODE_SIZE_LABEL ) );
206 _options_jmenu.add( _choose_minimal_confidence_mi = new JMenuItem( "" ) );
207 _options_jmenu.add( _overview_placment_mi = new JMenuItem( "" ) );
208 _options_jmenu.add( _switch_colors_mi = new JMenuItem( "" ) );
209 _options_jmenu.add( _choose_font_mi = new JMenuItem( "" ) );
210 _options_jmenu.addSeparator();
211 _options_jmenu.add( MainFrame.customizeMenuItemAsLabel( new JMenuItem( MainFrame.SEARCH_SUBHEADER ),
212 getConfiguration() ) );
214 .add( _search_case_senstive_cbmi = new JCheckBoxMenuItem( MainFrame.SEARCH_CASE_SENSITIVE_LABEL ) );
215 _options_jmenu.add( _search_whole_words_only_cbmi = new JCheckBoxMenuItem( MainFrame.SEARCH_TERMS_ONLY_LABEL ) );
216 _options_jmenu.add( _search_with_regex_cbmi = new JCheckBoxMenuItem( MainFrame.SEARCH_REGEX_LABEL ) );
217 _search_with_regex_cbmi.setToolTipText( MainFrame.SEARCH_WITH_REGEX_TIP );
218 _options_jmenu.add( _inverse_search_result_cbmi = new JCheckBoxMenuItem( INVERSE_SEARCH_RESULT_LABEL ) );
220 _options_jmenu.addSeparator();
221 _options_jmenu.add( customizeMenuItemAsLabel( new JMenuItem( "Graphics Export & Printing:" ),
222 getConfiguration() ) );
223 _options_jmenu.add( _antialias_print_cbmi = new JCheckBoxMenuItem( "Antialias" ) );
224 _options_jmenu.add( _print_black_and_white_cbmi = new JCheckBoxMenuItem( "Export in Black and White" ) );
226 .add( _print_using_actual_size_cbmi = new JCheckBoxMenuItem( "Use Current Image Size for PDF export and Printing" ) );
228 .add( _graphics_export_using_actual_size_cbmi = new JCheckBoxMenuItem( "Use Current Image Size for PNG, JPG, and GIF export" ) );
230 .add( _graphics_export_visible_only_cbmi = new JCheckBoxMenuItem( "Limit to Visible ('Screenshot') for PNG, JPG, and GIF export" ) );
231 _options_jmenu.add( _print_size_mi = new JMenuItem( "" ) );
232 _options_jmenu.add( _choose_pdf_width_mi = new JMenuItem( "" ) );
234 customizeCheckBoxMenuItem( _antialias_print_cbmi, getOptions().isAntialiasPrint() );
235 customizeCheckBoxMenuItem( _print_black_and_white_cbmi, getOptions().isPrintBlackAndWhite() );
236 customizeCheckBoxMenuItem( _graphics_export_visible_only_cbmi, getOptions().isGraphicsExportVisibleOnly() );
237 customizeCheckBoxMenuItem( _print_using_actual_size_cbmi, getOptions().isPrintUsingActualSize() );
238 customizeCheckBoxMenuItem( _graphics_export_using_actual_size_cbmi, getOptions()
239 .isGraphicsExportUsingActualSize() );
240 customizeJMenuItem( _print_size_mi );
241 customizeJMenuItem( _choose_pdf_width_mi );
243 customizeJMenuItem( _choose_font_mi );
244 customizeJMenuItem( _switch_colors_mi );
245 customizeJMenuItem( _choose_minimal_confidence_mi );
246 customizeJMenuItem( _overview_placment_mi );
247 customizeCheckBoxMenuItem( _show_default_node_shapes_internal_cbmi, getOptions()
248 .isShowDefaultNodeShapesInternal() );
249 customizeCheckBoxMenuItem( _show_default_node_shapes_external_cbmi, getOptions()
250 .isShowDefaultNodeShapesExternal() );
251 customizeCheckBoxMenuItem( _show_default_node_shapes_for_marked_cbmi, getOptions()
252 .isShowDefaultNodeShapesForMarkedNodes() );
253 customizeJMenuItem( _cycle_node_shape_mi );
254 customizeJMenuItem( _cycle_node_fill_mi );
255 customizeJMenuItem( _choose_node_size_mi );
256 customizeCheckBoxMenuItem( _color_by_taxonomic_group_cbmi, getOptions().isColorByTaxonomicGroup() );
257 customizeCheckBoxMenuItem( _color_labels_same_as_parent_branch, getOptions().isColorLabelsSameAsParentBranch() );
258 customizeCheckBoxMenuItem( _screen_antialias_cbmi, getOptions().isAntialiasScreen() );
259 customizeCheckBoxMenuItem( _background_gradient_cbmi, getOptions().isBackgroundColorGradient() );
260 customizeCheckBoxMenuItem( _show_domain_labels, getOptions().isShowDomainLabels() );
261 customizeCheckBoxMenuItem( _show_annotation_ref_source, getOptions().isShowAnnotationRefSource() );
262 customizeCheckBoxMenuItem( _abbreviate_scientific_names, getOptions().isAbbreviateScientificTaxonNames() );
263 customizeCheckBoxMenuItem( _search_case_senstive_cbmi, getOptions().isSearchCaseSensitive() );
264 customizeCheckBoxMenuItem( _show_scale_cbmi, getOptions().isShowScale() );
265 customizeRadioButtonMenuItem( _non_lined_up_cladograms_rbmi,
266 getOptions().getCladogramType() == CLADOGRAM_TYPE.NON_LINED_UP );
267 customizeRadioButtonMenuItem( _uniform_cladograms_rbmi,
268 getOptions().getCladogramType() == CLADOGRAM_TYPE.TOTAL_NODE_SUM_DEP );
269 customizeRadioButtonMenuItem( _ext_node_dependent_cladogram_rbmi,
270 getOptions().getCladogramType() == CLADOGRAM_TYPE.EXT_NODE_SUM_DEP );
271 customizeCheckBoxMenuItem( _show_overview_cbmi, getOptions().isShowOverview() );
272 customizeCheckBoxMenuItem( _label_direction_cbmi,
273 getOptions().getNodeLabelDirection() == NODE_LABEL_DIRECTION.RADIAL );
274 customizeCheckBoxMenuItem( _search_with_regex_cbmi, getOptions().isSearchWithRegex() );
275 customizeCheckBoxMenuItem( _search_whole_words_only_cbmi, getOptions().isMatchWholeTermsOnly() );
276 customizeCheckBoxMenuItem( _inverse_search_result_cbmi, getOptions().isInverseSearchResult() );
277 customizeCheckBoxMenuItem( _show_confidence_stddev_cbmi, getOptions().isShowConfidenceStddev() );
278 customizeCheckBoxMenuItem( _line_up_renderable_data_cbmi, getOptions().isLineUpRendarableNodeData() );
279 customizeCheckBoxMenuItem( _right_line_up_domains_cbmi, getOptions().isRightLineUpDomains() );
280 _jmenubar.add( _options_jmenu );
283 void buildToolsMenu() {
284 _tools_menu = MainFrame.createMenu( "Tools", getConfiguration() );
285 _tools_menu.add( _confcolor_item = new JMenuItem( "Colorize Branches Depending on Confidence" ) );
286 customizeJMenuItem( _confcolor_item );
287 _tools_menu.add( _taxcolor_item = new JMenuItem( "Taxonomy Colorize Branches" ) );
288 customizeJMenuItem( _taxcolor_item );
289 _tools_menu.addSeparator();
290 _tools_menu.add( _remove_visual_styles_item = new JMenuItem( "Delete All Visual Styles From Nodes" ) );
291 _remove_visual_styles_item
292 .setToolTipText( "To remove all node visual styles (fonts, colors) from the current phylogeny." );
293 customizeJMenuItem( _remove_visual_styles_item );
294 _tools_menu.add( _remove_branch_color_item = new JMenuItem( "Delete All Colors From Branches" ) );
295 _remove_branch_color_item.setToolTipText( "To remove all branch color values from the current phylogeny." );
296 customizeJMenuItem( _remove_branch_color_item );
297 _tools_menu.addSeparator();
298 _tools_menu.add( _midpoint_root_item = new JMenuItem( "Midpoint-Root" ) );
299 customizeJMenuItem( _midpoint_root_item );
300 _tools_menu.addSeparator();
301 _tools_menu.add( _collapse_species_specific_subtrees = new JMenuItem( "Collapse Species-Specific Subtrees" ) );
302 customizeJMenuItem( _collapse_species_specific_subtrees );
303 _jmenubar.add( _tools_menu );
306 JApplet getApplet() {
311 public MainPanel getMainPanel() {
315 private void readSpeciesTree( final Configuration configuration, final String species_tree_url_str )
316 throws MalformedURLException, FileNotFoundException, IOException {
317 final URL species_tree_url = new URL( species_tree_url_str );
318 final Phylogeny[] species_trees = AptxUtil.readPhylogeniesFromUrl( species_tree_url,
320 .isValidatePhyloXmlAgainstSchema(),
322 .isReplaceUnderscoresInNhParsing(),
324 TAXONOMY_EXTRACTION.NO,
326 if ( ( species_trees != null ) && ( species_trees.length > 0 ) ) {
327 AptxUtil.printAppletMessage( ArchaeopteryxA.NAME, "successfully read species tree" );
328 if ( species_trees[ 0 ].isEmpty() ) {
329 ForesterUtil.printErrorMessage( ArchaeopteryxA.NAME, "species tree is empty" );
331 else if ( !species_trees[ 0 ].isRooted() ) {
332 ForesterUtil.printErrorMessage( ArchaeopteryxA.NAME, "species tree is not rooted" );
335 setSpeciesTree( species_trees[ 0 ] );
336 AptxUtil.printAppletMessage( ArchaeopteryxA.NAME, "species tree OK" );
340 ForesterUtil.printErrorMessage( ArchaeopteryxA.NAME, "failed to read species tree from "
341 + species_tree_url_str );