TreeDisplaySettings (com.hfg API Documentation)

java.lang.Object
- com.hfg.setting.Settings
- - com.hfg.bio.phylogeny.TreeDisplaySettings

All Implemented Interfaces:

Cloneable
```
public class TreeDisplaySettings
extends Settings
```
Phylogenetic tree display options for use with NewickTree.

Constructor Summary

Constructors
Constructor and Description

TreeDisplaySettings()

Constructors
Constructor and Description
`TreeDisplaySettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`boundsCheckBranchLengthTraversalLimit(PhylogeneticTree inTree)`
`Boolean`	`getAlignLeaftNodeLabels()`
`Boolean`	`getAssignGroupsToSingletons()`
`String`	`getBLTL_OnChangeCallback()`
`String`	`getBLTL_SelectionCompleteCallback()`
`Float`	`getBranchLengthTraversalLimit()`
`CladogramStyle`	`getCladogramStyle()`
`Boolean`	`getEnableDynamicGrouping()`
`Font`	`getFont()`
`GfxSize`	`getLeafLabelLeftPadding()`
`GfxSize`	`getScalePaddingTop()`
`Integer`	`getScaleTickHeight()`
`Boolean`	`getShowBranchLengthTraversalLimit()`
`Boolean`	`getShowScale()`
`Integer`	`getTreeWidth()`
`protected void`	`init()` For subclasses to override.
`TreeDisplaySettings`	`setAlignLeaftNodeLabels(boolean inValue)`
`TreeDisplaySettings`	`setAssignGroupsToSingletons(boolean inValue)`
`TreeDisplaySettings`	`setBLTL_OnChangeCallback(String inValue)` While dynamically adjusting the branch length traversal limit to group closely related leaf nodes, this callback, if defined, is invoked so the changing BLTL value can be displayed.
`TreeDisplaySettings`	`setBLTL_SelectionCompleteCallback(String inValue)` When the dynamic adjustment of the branch length traversal limit to group closely related leaf nodes is completed (end of drag event), this callback, if defined, is invoked.
`TreeDisplaySettings`	`setBranchLengthTraversalLimit(Float inValue)`
`TreeDisplaySettings`	`setCladogramStyle(CladogramStyle inValue)`
`TreeDisplaySettings`	`setEnableDynamicGrouping(boolean inValue)` When outputting the tree in SVG, this option allows for dynamically adjusting the branch length traversal limit to group closely related leaf nodes.
`TreeDisplaySettings`	`setFont(Font inValue)`
`TreeDisplaySettings`	`setLeafLabelLeftPadding(GfxSize inValue)`
`TreeDisplaySettings`	`setScalePaddingTop(GfxSize inValue)`
`TreeDisplaySettings`	`setScaleTickHeight(int inValue)`
`TreeDisplaySettings`	`setShowBranchLengthTraversalLimit(boolean inValue)`
`TreeDisplaySettings`	`setShowScale(boolean inValue)`
`TreeDisplaySettings`	`setTreeWidth(int inValue)`

Methods inherited from class com.hfg.setting.Settings
add, clone, get, name, setName, setTagName, size, toXMLTag

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TreeDisplaySettings
```
public TreeDisplaySettings()
```
- Method Detail
  - init
```
protected void init()
```
    Description copied from class: Settings
    
    For subclasses to override.
    
    Overrides:
    
    init in class Settings
  - setCladogramStyle
```
public TreeDisplaySettings setCladogramStyle(CladogramStyle inValue)
```
  - getCladogramStyle
```
public CladogramStyle getCladogramStyle()
```
  - setTreeWidth
```
public TreeDisplaySettings setTreeWidth(int inValue)
```
  - getTreeWidth
```
public Integer getTreeWidth()
```
  - setAssignGroupsToSingletons
```
public TreeDisplaySettings setAssignGroupsToSingletons(boolean inValue)
```
  - getAssignGroupsToSingletons
```
public Boolean getAssignGroupsToSingletons()
```
  - setAlignLeaftNodeLabels
```
public TreeDisplaySettings setAlignLeaftNodeLabels(boolean inValue)
```
  - getAlignLeaftNodeLabels
```
public Boolean getAlignLeaftNodeLabels()
```
  - setShowScale
```
public TreeDisplaySettings setShowScale(boolean inValue)
```
  - getShowScale
```
public Boolean getShowScale()
```
  - setEnableDynamicGrouping
```
public TreeDisplaySettings setEnableDynamicGrouping(boolean inValue)
```
    When outputting the tree in SVG, this option allows for dynamically adjusting the branch length traversal limit to group closely related leaf nodes.
    
    Parameters:
    
    inValue - whether or not to enable the dynamic grouping option
    
    Returns:
    
    this Settings object to allow method chaining
  - getEnableDynamicGrouping
```
public Boolean getEnableDynamicGrouping()
```
  - setBranchLengthTraversalLimit
```
public TreeDisplaySettings setBranchLengthTraversalLimit(Float inValue)
```
  - getBranchLengthTraversalLimit
```
public Float getBranchLengthTraversalLimit()
```
  - boundsCheckBranchLengthTraversalLimit
```
public void boundsCheckBranchLengthTraversalLimit(PhylogeneticTree inTree)
```
  - setShowBranchLengthTraversalLimit
```
public TreeDisplaySettings setShowBranchLengthTraversalLimit(boolean inValue)
```
  - getShowBranchLengthTraversalLimit
```
public Boolean getShowBranchLengthTraversalLimit()
```
  - setBLTL_OnChangeCallback
```
public TreeDisplaySettings setBLTL_OnChangeCallback(String inValue)
```
    While dynamically adjusting the branch length traversal limit to group closely related leaf nodes, this callback, if defined, is invoked so the changing BLTL value can be displayed.
    
    Parameters:
    
    inValue - the javascript method to invoke (with the new BLTL value, and the drag handle object as arguments)
    
    Returns:
    
    this Settings object to allow method chaining
  - getBLTL_OnChangeCallback
```
public String getBLTL_OnChangeCallback()
```
  - setBLTL_SelectionCompleteCallback
```
public TreeDisplaySettings setBLTL_SelectionCompleteCallback(String inValue)
```
    When the dynamic adjustment of the branch length traversal limit to group closely related leaf nodes is completed (end of drag event), this callback, if defined, is invoked.
    
    Parameters:
    
    inValue - the javascript method to invoke (with the new BLTL value, and the drag handle object as arguments)
    
    Returns:
    
    this Settings object to allow method chaining
  - getBLTL_SelectionCompleteCallback
```
public String getBLTL_SelectionCompleteCallback()
```
  - setFont
```
public TreeDisplaySettings setFont(Font inValue)
```
  - getFont
```
public Font getFont()
```
  - setLeafLabelLeftPadding
```
public TreeDisplaySettings setLeafLabelLeftPadding(GfxSize inValue)
```
  - getLeafLabelLeftPadding
```
public GfxSize getLeafLabelLeftPadding()
```
  - setScaleTickHeight
```
public TreeDisplaySettings setScaleTickHeight(int inValue)
```
  - getScaleTickHeight
```
public Integer getScaleTickHeight()
```
  - setScalePaddingTop
```
public TreeDisplaySettings setScalePaddingTop(GfxSize inValue)
```
  - getScalePaddingTop
```
public GfxSize getScalePaddingTop()
```

Class TreeDisplaySettings

Constructor Summary

Method Summary

Methods inherited from class com.hfg.setting.Settings

Methods inherited from class java.lang.Object

Constructor Detail

TreeDisplaySettings

Method Detail

init

setCladogramStyle

getCladogramStyle

setTreeWidth

getTreeWidth

setAssignGroupsToSingletons

getAssignGroupsToSingletons

setAlignLeaftNodeLabels

getAlignLeaftNodeLabels

setShowScale

getShowScale

setEnableDynamicGrouping

getEnableDynamicGrouping

setBranchLengthTraversalLimit

getBranchLengthTraversalLimit

boundsCheckBranchLengthTraversalLimit

setShowBranchLengthTraversalLimit

getShowBranchLengthTraversalLimit

setBLTL_OnChangeCallback

getBLTL_OnChangeCallback

setBLTL_SelectionCompleteCallback

getBLTL_SelectionCompleteCallback

setFont

getFont

setLeafLabelLeftPadding

getLeafLabelLeftPadding

setScaleTickHeight

getScaleTickHeight

setScalePaddingTop

getScalePaddingTop