org.barfuin.texttree.api.style

Class TreeStyle

java.lang.Object

org.barfuin.texttree.api.style.TreeStyle

public class TreeStyle
extends Object

Describes a tree style, giving all the text elements needed for rendering. This class is useful for implementing custom tree styles. Pre-defined tree styles are available in the TreeStyles class.

The README on the project's website has detailed information about how to define custom tree styles.

See Also:

TreeStyles

Constructor Summary

Constructors

Constructor and Description
TreeStyle(String pJunction, String pIndent, String pLastJunction) Constructor.
TreeStyle(String pJunction, String pIndent, String pLastJunction, String pCalloutStart, String pCalloutEnd) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getBlankIndent()
String	getBlankIndentTrimmed()
String	getCalloutEnd()
String	getCalloutStart()
String	getIndent()
String	getIndentTrimmed()
String	getJunction()
String	getLastJunction()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TreeStyle

public TreeStyle(String pJunction,
                 String pIndent,
                 String pLastJunction)

Constructor. All arguments are required and the junction elements must be of equal length. Callouts will be enclosed in angle brackets.

Parameters:

pJunction - the text fragment for an edge with a junction

pIndent - the text fragment for an edge without a junction

pLastJunction - the text fragment for a junction which is the last in its node (the last child of a node)

See Also:

TreeStyles

TreeStyle

public TreeStyle(String pJunction,
                 String pIndent,
                 String pLastJunction,
                 String pCalloutStart,
                 String pCalloutEnd)

Constructor. All arguments are required and the junction elements must be of equal length.

Parameters:

pJunction - the text fragment for an edge with a junction

pIndent - the text fragment for an edge without a junction

pLastJunction - the text fragment for a junction which is the last in its node (the last child of a node)

pCalloutStart - the text fragment printed in front of a callout, for example "<"

pCalloutEnd - the text fragment printed after the end of a callout, for example ">"

See Also:

TreeStyles

Method Detail

getBlankIndent

@Nonnull
public String getBlankIndent()

getBlankIndentTrimmed

@Nonnull
public String getBlankIndentTrimmed()

getCalloutEnd

@Nonnull
public String getCalloutEnd()

getCalloutStart

@Nonnull
public String getCalloutStart()

getIndent

@Nonnull
public String getIndent()

getIndentTrimmed

@Nonnull
public String getIndentTrimmed()

getJunction

@Nonnull
public String getJunction()

getLastJunction

@Nonnull
public String getLastJunction()