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 pIndent, String pJunction, String pLastJunction, String pAnnotationStart, String pAnnotationEnd, String pCalloutStart, String pCalloutEnd) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getAnnotationEnd()
String	getAnnotationStart()
String	getBlankIndent()
String	getCalloutEnd()
String	getCalloutStart()
String	getIndent()
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 pIndent,
                 String pJunction,
                 String pLastJunction,
                 String pAnnotationStart,
                 String pAnnotationEnd,
                 String pCalloutStart,
                 String pCalloutEnd)

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

Parameters:

pIndent - the text fragment used for continuing a higher level to the left of the current node

pJunction - the text fragment for a junction in the tree (a child node)

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

pAnnotationStart - text fragment printed in front of an annotation, normally an opening parenthesis

pAnnotationEnd - text fragment printed after the end of an annotation, normally a closing parenthesis

pCalloutStart - text fragment printed in front of a callout, normally an opening angle bracket

pCalloutEnd - text fragment printed after the end of a callout, normally a closing angle bracket

See Also:

TreeStyles

Method Detail

getAnnotationEnd

@Nonnull
public String getAnnotationEnd()

getAnnotationStart

@Nonnull
public String getAnnotationStart()

getBlankIndent

@Nonnull
public String getBlankIndent()

getCalloutEnd

@Nonnull
public String getCalloutEnd()

getCalloutStart

@Nonnull
public String getCalloutStart()

getIndent

@Nonnull
public String getIndent()

getJunction

@Nonnull
public String getJunction()

getLastJunction

@Nonnull
public String getLastJunction()