JAL-2805 JAL-281 JAL-2847 set tree file made public as well (heh)
[jalview.git] / forester / java / src / org / forester / archaeopteryx / Options.java
1 // $Id:
2 // FORESTER -- software libraries and applications
3 // for evolutionary biology research and applications.
4 //
5 // Copyright (C) 2009 Christian M. Zmasek
6 // Copyright (C) 2009 Burnham Institute for Medical Research
7 // All rights reserved
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU Lesser General Public
11 // License as published by the Free Software Foundation; either
12 // version 2.1 of the License, or (at your option) any later version.
13 //
14 // This library is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // Lesser General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public
20 // License along with this library; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 //
23 // Contact: phylosoft @ gmail . com
24 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
25
26 package org.forester.archaeopteryx;
27
28 import java.awt.Font;
29
30 import org.forester.io.parsers.nhx.NHXParser.TAXONOMY_EXTRACTION;
31 import org.forester.phylogeny.PhylogenyNode.NH_CONVERSION_SUPPORT_VALUE_STYLE;
32 import org.forester.phylogeny.data.NodeDataField;
33 import org.forester.phylogeny.data.NodeVisualData;
34 import org.forester.phylogeny.data.NodeVisualData.NodeFill;
35 import org.forester.phylogeny.data.NodeVisualData.NodeShape;
36 import org.forester.util.ForesterUtil;
37
38 /*
39  * This is to hold changeable options.
40  */
41 final public class Options {
42
43     public static enum CLADOGRAM_TYPE {
44         LINED_UP, NON_LINED_UP;
45     }
46
47     public static enum NODE_LABEL_DIRECTION {
48         HORIZONTAL, RADIAL;
49     }
50
51     public static enum PHYLOGENY_GRAPHICS_TYPE {
52         CIRCULAR, CONVEX, CURVED, EURO_STYLE, RECTANGULAR, ROUNDED, TRIANGULAR, UNROOTED;
53     }
54     
55     static enum PHYLOGENY_DISPLAY_TYPE {
56         CLADOGRAM,
57         ALIGNED_PHYLOGRAM,
58         UNALIGNED_PHYLOGRAM
59     }
60
61     static enum OVERVIEW_PLACEMENT_TYPE {
62         LOWER_LEFT( "lower left" ),
63         LOWER_RIGHT( "lower right" ),
64         UPPER_LEFT( "upper left" ),
65         UPPER_RIGHT( "upper right" );
66
67         private final String _name;
68
69         private OVERVIEW_PLACEMENT_TYPE( final String name ) {
70             _name = name;
71         }
72
73         @Override
74         public String toString() {
75             return _name;
76         }
77
78         public String toTag() {
79             return toString().replaceAll( " ", "_" );
80         }
81     }
82    
83     static final double                       MIN_CONFIDENCE_DEFAULT = 0.0;
84     private boolean                           _abbreviate_scientific_names;
85     private boolean                           _allow_errors_in_distance_to_parent;
86     private boolean                           _antialias_print;
87     private boolean                           _antialias_screen;
88     private boolean                           _background_color_gradient;
89     private Font                              _base_font;
90     private CLADOGRAM_TYPE                    _cladogram_type;
91     private boolean                           _color_by_taxonomic_group;
92     private boolean                           _color_labels_same_as_parent_branch;
93     private NodeVisualData.NodeFill           _default_node_fill;
94     private NodeVisualData.NodeShape          _default_node_shape;
95     private short                             _default_node_shape_size;
96     private boolean                           _editable;
97     private NodeDataField                     _ext_desc_data_to_return;
98     private final boolean                     _graphics_export_using_actual_size = true;
99     private boolean                           _graphics_export_visible_only;
100     private boolean                           _internal_number_are_confidence_for_nh_parsing;
101     private boolean                           _inverse_search_result;
102     private boolean                           _match_whole_terms_only;
103     private boolean                           _search_with_regex;
104     private double                            _min_confidence_value;
105     private NH_CONVERSION_SUPPORT_VALUE_STYLE _nh_conversion_support_value_style;
106     private boolean                           _nh_parsing_replace_underscores;
107     private NODE_LABEL_DIRECTION              _node_label_direction;
108     private short                             _number_of_digits_after_comma_for_branch_length_values;
109     private short                             _number_of_digits_after_comma_for_confidence_values;
110     private OVERVIEW_PLACEMENT_TYPE           _ov_placement;
111     private PHYLOGENY_GRAPHICS_TYPE           _phylogeny_graphics_type;
112     private boolean                           _print_black_and_white;
113     private float                             _print_line_width;
114     private final boolean                     _print_using_actual_size = true;
115     private double                            _scale_bar_length;
116     private boolean                           _search_case_sensitive;
117     private boolean                           _show_annotation_ref_source;
118     private boolean                           _show_confidence_stddev;
119     private boolean                           _show_default_node_shapes_for_marked_nodes;
120     private boolean                           _show_default_node_shapes_external;
121     private boolean                           _show_default_node_shapes_internal;
122     private boolean                           _show_domain_labels;
123     private boolean                           _show_overview;
124     private boolean                           _show_scale;
125     private TAXONOMY_EXTRACTION               _taxonomy_extraction;
126     private boolean                           _line_up_renderable_node_data;
127     private boolean                           _right_align_domains;
128     private boolean                           _color_all_found_nodes_when_coloring_subtree;
129     private boolean                           _parse_beast_style_extended_nexus_tags;
130     private boolean                           _collapsed_with_average_height;
131     private boolean                           _show_abbreviated_labels_for_collapsed_nodes;
132     
133     private Options() {
134         init();
135     }
136
137     public NodeDataField getExtDescNodeDataToReturn() {
138         return _ext_desc_data_to_return;
139     }
140
141     public boolean isAllowErrorsInDistanceToParent() {
142         return _allow_errors_in_distance_to_parent;
143     }
144
145     final public boolean isLineUpRendarableNodeData() {
146         return _line_up_renderable_node_data;
147     }
148
149     final public boolean isRightLineUpDomains() {
150         return _right_align_domains;
151     }
152
153     public final boolean isShowAnnotationRefSource() {
154         return _show_annotation_ref_source;
155     }
156
157     public final boolean isShowDomainLabels() {
158         return _show_domain_labels;
159     }
160
161     public final void setAllowErrorsInDistanceToParent( final boolean allow_errors_in_distance_to_parent ) {
162         _allow_errors_in_distance_to_parent = allow_errors_in_distance_to_parent;
163     }
164
165     public void setBackgroundColorGradient( final boolean background_color_gradient ) {
166         _background_color_gradient = background_color_gradient;
167     }
168
169     public void setColorLabelsSameAsParentBranch( final boolean color_labels_same_as_parent_branch ) {
170         _color_labels_same_as_parent_branch = color_labels_same_as_parent_branch;
171     }
172
173     public void setExtDescNodeDataToReturn( final NodeDataField ext_desc_data_to_return ) {
174         _ext_desc_data_to_return = ext_desc_data_to_return;
175     }
176
177     final public void setLineUpRendarableNodeData( final boolean line_up_renderable_node_data ) {
178         _line_up_renderable_node_data = line_up_renderable_node_data;
179     }
180
181     final public void setRightLineUpDomains( final boolean right_align_domains ) {
182         _right_align_domains = right_align_domains;
183     }
184
185     public final void setShowAnnotationRefSource( final boolean show_annotation_ref_source ) {
186         _show_annotation_ref_source = show_annotation_ref_source;
187     }
188
189     public void setShowDomainLabels( final boolean show_domain_labels ) {
190         _show_domain_labels = show_domain_labels;
191     }
192
193     final private void init() {
194         _default_node_shape = NodeShape.CIRCLE;
195         _default_node_fill = NodeFill.GRADIENT;
196         _default_node_shape_size = AptxConstants.DEFAULT_NODE_SHAPE_SIZE_DEFAULT;
197         _internal_number_are_confidence_for_nh_parsing = false;
198         _show_scale = false;
199         _antialias_screen = true;
200         _antialias_print = true;
201         _graphics_export_visible_only = false;
202         _editable = true;
203         _background_color_gradient = false;
204         _show_default_node_shapes_internal = false;
205         _show_default_node_shapes_external = false;
206         _show_default_node_shapes_for_marked_nodes = false;
207         _color_all_found_nodes_when_coloring_subtree = false;
208         _parse_beast_style_extended_nexus_tags= true;
209         _min_confidence_value = MIN_CONFIDENCE_DEFAULT;
210         _print_black_and_white = false;
211         _phylogeny_graphics_type = PHYLOGENY_GRAPHICS_TYPE.RECTANGULAR;
212         _base_font = new Font( Configuration.getDefaultFontFamilyName(), Font.PLAIN, 10 );
213         _match_whole_terms_only = false;
214         _search_with_regex = false;
215         _search_case_sensitive = false;
216         _print_line_width = AptxConstants.PDF_LINE_WIDTH_DEFAULT;
217         _show_overview = true;
218         _ov_placement = OVERVIEW_PLACEMENT_TYPE.UPPER_LEFT;
219         _node_label_direction = NODE_LABEL_DIRECTION.HORIZONTAL;
220         _inverse_search_result = false;
221         _scale_bar_length = 0.0;
222         _number_of_digits_after_comma_for_branch_length_values = AptxConstants.NUMBER_OF_DIGITS_AFTER_COMMA_FOR_BRANCH_LENGTH_VALUES_DEFAULT;
223         _number_of_digits_after_comma_for_confidence_values = AptxConstants.NUMBER_OF_DIGITS_AFTER_COMMA_FOR_CONFIDENCE_VALUES_DEFAULT;
224         _nh_parsing_replace_underscores = false;
225         _taxonomy_extraction = TAXONOMY_EXTRACTION.NO;
226         _cladogram_type = AptxConstants.CLADOGRAM_TYPE_DEFAULT;
227         _show_domain_labels = true;
228         _show_annotation_ref_source = true;
229         setAbbreviateScientificTaxonNames( false );
230         _color_labels_same_as_parent_branch = false;
231         _show_confidence_stddev = false;
232         _nh_conversion_support_value_style = NH_CONVERSION_SUPPORT_VALUE_STYLE.NONE;
233         _ext_desc_data_to_return = NodeDataField.UNKNOWN;
234         _line_up_renderable_node_data = true;
235         _right_align_domains = false;
236         _collapsed_with_average_height = true;
237         _show_abbreviated_labels_for_collapsed_nodes = true;
238     }
239
240     final private void setNumberOfDigitsAfterCommaForBranchLength( final short number_of_digits_after_comma_for_branch_length_values ) {
241         _number_of_digits_after_comma_for_branch_length_values = number_of_digits_after_comma_for_branch_length_values;
242     }
243
244     final private void setNumberOfDigitsAfterCommaForConfidenceValues( final short number_of_digits_after_comma_for_confidence_values ) {
245         _number_of_digits_after_comma_for_confidence_values = number_of_digits_after_comma_for_confidence_values;
246     }
247
248     final Font getBaseFont() {
249         return _base_font;
250     }
251
252     final CLADOGRAM_TYPE getCladogramType() {
253         return _cladogram_type;
254     }
255
256     final NodeFill getDefaultNodeFill() {
257         return _default_node_fill;
258     }
259
260     final NodeShape getDefaultNodeShape() {
261         return _default_node_shape;
262     }
263
264     final short getDefaultNodeShapeSize() {
265         return _default_node_shape_size;
266     }
267
268     final double getMinConfidenceValue() {
269         return _min_confidence_value;
270     }
271
272     NH_CONVERSION_SUPPORT_VALUE_STYLE getNhConversionSupportValueStyle() {
273         return _nh_conversion_support_value_style;
274     }
275
276     final NODE_LABEL_DIRECTION getNodeLabelDirection() {
277         return _node_label_direction;
278     }
279
280     final short getNumberOfDigitsAfterCommaForBranchLengthValues() {
281         return _number_of_digits_after_comma_for_branch_length_values;
282     }
283
284     final short getNumberOfDigitsAfterCommaForConfidenceValues() {
285         return _number_of_digits_after_comma_for_confidence_values;
286     }
287
288     final OVERVIEW_PLACEMENT_TYPE getOvPlacement() {
289         return _ov_placement;
290     }
291
292     final PHYLOGENY_GRAPHICS_TYPE getPhylogenyGraphicsType() {
293         return _phylogeny_graphics_type;
294     }
295
296     final float getPrintLineWidth() {
297         return _print_line_width;
298     }
299
300     final double getScaleBarLength() {
301         return _scale_bar_length;
302     }
303
304     final TAXONOMY_EXTRACTION getTaxonomyExtraction() {
305         return _taxonomy_extraction;
306     }
307
308     final boolean isAbbreviateScientificTaxonNames() {
309         return _abbreviate_scientific_names;
310     }
311
312     boolean isAllowMagnificationOfTaxonomyImages() {
313         return true;
314     }
315
316     final boolean isAntialiasPrint() {
317         return _antialias_print;
318     }
319
320     final boolean isAntialiasScreen() {
321         return _antialias_screen;
322     }
323
324     final boolean isBackgroundColorGradient() {
325         return _background_color_gradient;
326     }
327
328     final boolean isColorByTaxonomicGroup() {
329         return _color_by_taxonomic_group;
330     }
331
332     final boolean isColorLabelsSameAsParentBranch() {
333         return _color_labels_same_as_parent_branch;
334     }
335
336     final boolean isEditable() {
337         return _editable;
338     }
339
340     final boolean isGraphicsExportUsingActualSize() {
341         return _graphics_export_using_actual_size;
342     }
343
344     final boolean isGraphicsExportVisibleOnly() {
345         return _graphics_export_visible_only;
346     }
347
348     final boolean isInternalNumberAreConfidenceForNhParsing() {
349         return _internal_number_are_confidence_for_nh_parsing;
350     }
351
352     final boolean isInverseSearchResult() {
353         return _inverse_search_result;
354     }
355
356     final boolean isMatchWholeTermsOnly() {
357         return _match_whole_terms_only;
358     }
359
360     final boolean isPrintBlackAndWhite() {
361         return _print_black_and_white;
362     }
363
364     final boolean isPrintUsingActualSize() {
365         return _print_using_actual_size;
366     }
367
368     final boolean isReplaceUnderscoresInNhParsing() {
369         return _nh_parsing_replace_underscores;
370     }
371
372     final boolean isSearchCaseSensitive() {
373         return _search_case_sensitive;
374     }
375
376     final boolean isSearchWithRegex() {
377         return _search_with_regex;
378     }
379
380     boolean isShowConfidenceStddev() {
381         return _show_confidence_stddev;
382     }
383
384     boolean isShowDefaultNodeShapesExternal() {
385         return _show_default_node_shapes_external;
386     }
387
388     boolean isShowDefaultNodeShapesForMarkedNodes() {
389         return _show_default_node_shapes_for_marked_nodes;
390     }
391
392     boolean isShowDefaultNodeShapesInternal() {
393         return _show_default_node_shapes_internal;
394     }
395
396     final boolean isShowOverview() {
397         return _show_overview;
398     }
399
400     final boolean isShowScale() {
401         return _show_scale;
402     }
403
404     final void setAbbreviateScientificTaxonNames( final boolean abbreviate_scientific_names ) {
405         _abbreviate_scientific_names = abbreviate_scientific_names;
406     }
407
408     final void setAntialiasPrint( final boolean antialias_print ) {
409         _antialias_print = antialias_print;
410     }
411
412     final void setAntialiasScreen( final boolean antialias_screen ) {
413         _antialias_screen = antialias_screen;
414     }
415
416     final void setBaseFont( final Font base_font ) {
417         _base_font = base_font;
418     }
419
420     final void setCladogramType( final CLADOGRAM_TYPE cladogram_type ) {
421         _cladogram_type = cladogram_type;
422     }
423
424     final void setColorByTaxonomicGroup( final boolean color_by_taxonomic_group ) {
425         _color_by_taxonomic_group = color_by_taxonomic_group;
426     }
427
428     final void setDefaultNodeFill( final NodeFill default_node_fill ) {
429         _default_node_fill = default_node_fill;
430     }
431
432     final void setDefaultNodeShape( final NodeShape default_node_shape ) {
433         _default_node_shape = default_node_shape;
434     }
435
436     final void setDefaultNodeShapeSize( final short default_node_shape_size ) {
437         _default_node_shape_size = default_node_shape_size;
438     }
439
440     final void setEditable( final boolean editable ) {
441         _editable = editable;
442     }
443
444     final void setGraphicsExportVisibleOnly( final boolean graphics_export_visible_only ) {
445         _graphics_export_visible_only = graphics_export_visible_only;
446     }
447
448     final void setInternalNumberAreConfidenceForNhParsing( final boolean internal_number_are_confidence_for_nh_parsing ) {
449         _internal_number_are_confidence_for_nh_parsing = internal_number_are_confidence_for_nh_parsing;
450     }
451
452     final void setInverseSearchResult( final boolean inverse_search_result ) {
453         _inverse_search_result = inverse_search_result;
454     }
455
456     final void setMatchWholeTermsOnly( final boolean search_whole_words_only ) {
457         _match_whole_terms_only = search_whole_words_only;
458     }
459
460     final void setMinConfidenceValue( final double min_confidence_value ) {
461         _min_confidence_value = min_confidence_value;
462     }
463
464     void setNhConversionSupportValueStyle( final NH_CONVERSION_SUPPORT_VALUE_STYLE nh_conversion_support_value_style ) {
465         _nh_conversion_support_value_style = nh_conversion_support_value_style;
466     }
467
468     final void setNodeLabelDirection( final NODE_LABEL_DIRECTION node_label_direction ) {
469         _node_label_direction = node_label_direction;
470     }
471
472     final void setOvPlacement( final OVERVIEW_PLACEMENT_TYPE ov_placement ) {
473         _ov_placement = ov_placement;
474     }
475
476     final void setPhylogenyGraphicsType( final PHYLOGENY_GRAPHICS_TYPE phylogeny_graphics_type ) {
477         _phylogeny_graphics_type = phylogeny_graphics_type;
478     }
479
480     final void setPrintBlackAndWhite( final boolean print_black_and_white ) {
481         _print_black_and_white = print_black_and_white;
482     }
483
484     final void setPrintLineWidth( final float print_line_width ) {
485         _print_line_width = print_line_width;
486     }
487     
488     final void setReplaceUnderscoresInNhParsing( final boolean nh_parsing_replace_underscores ) {
489         _nh_parsing_replace_underscores = nh_parsing_replace_underscores;
490     }
491
492     final void setScaleBarLength( final double scale_bar_length ) {
493         _scale_bar_length = scale_bar_length;
494     }
495
496     final void setSearchCaseSensitive( final boolean search_case_sensitive ) {
497         _search_case_sensitive = search_case_sensitive;
498     }
499
500     final void setSearchWithRegex( final boolean search_with_regex ) {
501         _search_with_regex = search_with_regex;
502     }
503
504     void setShowConfidenceStddev( final boolean show_confidence_stddev ) {
505         _show_confidence_stddev = show_confidence_stddev;
506     }
507
508     void setShowDefaultNodeShapesExternal( final boolean show_default_node_shapes_external ) {
509         _show_default_node_shapes_external = show_default_node_shapes_external;
510     }
511
512     void setShowDefaultNodeShapesForMarkedNodes( final boolean show_default_node_shapes_for_marked_nodes ) {
513         _show_default_node_shapes_for_marked_nodes = show_default_node_shapes_for_marked_nodes;
514     }
515
516     void setShowDefaultNodeShapesInternal( final boolean show_default_node_shapes_internal ) {
517         _show_default_node_shapes_internal = show_default_node_shapes_internal;
518     }
519
520     final void setShowOverview( final boolean show_overview ) {
521         _show_overview = show_overview;
522     }
523
524     final void setShowScale( final boolean show_scale ) {
525         _show_scale = show_scale;
526     }
527
528     final void setTaxonomyExtraction( final TAXONOMY_EXTRACTION taxonomy_extraction ) {
529         _taxonomy_extraction = taxonomy_extraction;
530     }
531
532     public final static Options createInstance( final Configuration configuration ) {
533         final Options instance = createDefaultInstance();
534         if ( configuration != null ) {
535             instance.setAntialiasScreen( configuration.isAntialiasScreen() );
536             instance.setShowScale( configuration.isShowScale() );
537             instance.setShowOverview( configuration.isShowOverview() );
538             instance.setColorByTaxonomicGroup( configuration.isColorByTaxonomicGroup() );
539             instance.setCladogramType( configuration.getCladogramType() );
540             instance.setOvPlacement( configuration.getOvPlacement() );
541             instance.setPrintLineWidth( configuration.getPrintLineWidth() );
542             instance.setNodeLabelDirection( configuration.getNodeLabelDirection() );
543             instance.setBackgroundColorGradient( configuration.isBackgroundColorGradient() );
544             if ( configuration.getNumberOfDigitsAfterCommaForBranchLengthValues() >= 0 ) {
545                 instance.setNumberOfDigitsAfterCommaForBranchLength( configuration
546                         .getNumberOfDigitsAfterCommaForBranchLengthValues() );
547             }
548             if ( configuration.getNumberOfDigitsAfterCommaForConfidenceValues() >= 0 ) {
549                 instance.setNumberOfDigitsAfterCommaForConfidenceValues( configuration
550                         .getNumberOfDigitsAfterCommaForConfidenceValues() );
551             }
552             instance.setTaxonomyExtraction( configuration.getTaxonomyExtraction() );
553             instance.setReplaceUnderscoresInNhParsing( configuration.isReplaceUnderscoresInNhParsing() );
554             instance.setInternalNumberAreConfidenceForNhParsing( configuration
555                     .isInternalNumberAreConfidenceForNhParsing() );
556             instance.setEditable( configuration.isEditable() );
557             instance.setColorLabelsSameAsParentBranch( configuration.isColorLabelsSameAsParentBranch() );
558             instance.setShowDomainLabels( configuration.isShowDomainLabels() );
559             instance.setShowAnnotationRefSource( configuration.isShowAnnotationRefSource() );
560             instance.setAbbreviateScientificTaxonNames( configuration.isAbbreviateScientificTaxonNames() );
561             if ( configuration.getMinConfidenceValue() != MIN_CONFIDENCE_DEFAULT ) {
562                 instance.setMinConfidenceValue( configuration.getMinConfidenceValue() );
563             }
564             if ( configuration.getBaseFontSize() > 0 ) {
565                 instance.setBaseFont( instance.getBaseFont().deriveFont( ( float ) configuration.getBaseFontSize() ) );
566             }
567             if ( !ForesterUtil.isEmpty( configuration.getBaseFontFamilyName() ) ) {
568                 instance.setBaseFont( new Font( configuration.getBaseFontFamilyName(), Font.PLAIN, instance
569                         .getBaseFont().getSize() ) );
570             }
571             if ( configuration.getPhylogenyGraphicsType() != null ) {
572                 instance.setPhylogenyGraphicsType( configuration.getPhylogenyGraphicsType() );
573             }
574             if ( configuration.getDefaultNodeFill() != null ) {
575                 instance.setDefaultNodeFill( configuration.getDefaultNodeFill() );
576             }
577             if ( configuration.getDefaultNodeShape() != null ) {
578                 instance.setDefaultNodeShape( configuration.getDefaultNodeShape() );
579             }
580             if ( configuration.getDefaultNodeShapeSize() >= 0 ) {
581                 instance.setDefaultNodeShapeSize( configuration.getDefaultNodeShapeSize() );
582             }
583             instance.setShowDefaultNodeShapesInternal( configuration.isShowDefaultNodeShapesInternal() );
584             instance.setShowDefaultNodeShapesExternal( configuration.isShowDefaultNodeShapesExternal() );
585             instance.setShowDefaultNodeShapesForMarkedNodes( configuration.isShowDefaultNodeShapesForMarkedNodes() );
586             if ( configuration.getExtDescNodeDataToReturn() != null ) {
587                 instance.setExtDescNodeDataToReturn( configuration.getExtDescNodeDataToReturn() );
588             }
589             instance.setRightLineUpDomains( configuration.isRightLineUpDomains() );
590             instance.setLineUpRendarableNodeData( configuration.isLineUpRendarableNodeData() );
591             instance.setAllowErrorsInDistanceToParent( false );
592         }
593         return instance;
594     }
595
596     final static Options createDefaultInstance() {
597         return new Options();
598     }
599
600     final boolean isColorAllFoundNodesWhenColoringSubtree() {
601         return _color_all_found_nodes_when_coloring_subtree;
602     }
603     
604     final void setColorAllFoundNodesWhenColoringSubtree( final boolean color_all_found_nodes_when_coloring_subtree ) {
605         _color_all_found_nodes_when_coloring_subtree = color_all_found_nodes_when_coloring_subtree;
606     }
607
608     final boolean isParseBeastStyleExtendedNexusTags() {
609         return _parse_beast_style_extended_nexus_tags;
610     }
611
612     final void setParseBeastStyleExtendedNexusTags( final boolean parse_beast_style_extended_nexus_tags ) {
613         _parse_beast_style_extended_nexus_tags = parse_beast_style_extended_nexus_tags;
614     }
615     
616     final boolean isCollapsedWithAverageHeigh() {
617         return _collapsed_with_average_height;
618     }
619
620     final void setCollapsedWithAverageHeigh( final boolean collapsed_with_average_height ) {
621         _collapsed_with_average_height = collapsed_with_average_height;
622     }
623
624     final boolean isShowAbbreviatedLabelsForCollapsedNodes() {
625         return _show_abbreviated_labels_for_collapsed_nodes;
626     }
627     
628     final void setShowAbbreviatedLabelsForCollapsedNodes(final boolean show_abbreviated_labels_for_collapsed_nodes) {
629         _show_abbreviated_labels_for_collapsed_nodes =  show_abbreviated_labels_for_collapsed_nodes;
630     }
631     
632    
633     
634 }