com.github.jferard.fastods

Class TextBuilder

java.lang.Object

com.github.jferard.fastods.TextBuilder

public class TextBuilder
extends Object

A text builder builds a text block: list of paragraphs.

Author:

Julien Férard

Method Summary

Modifier and Type	Method and Description
Text	build()
static TextBuilder	create()
TextBuilder	link(String text, File file) Create a link in the current paragraph.
TextBuilder	link(String text, String ref) Create a link in the current paragraph.
TextBuilder	link(String text, Table table) Create a link in the current paragraph.
TextBuilder	link(String text, URI uri) Create a link in the current paragraph.
TextBuilder	link(String text, URL url) Create a link in the current paragraph.
TextBuilder	par() Create a new paragraph
TextBuilder	parContent(String text) Create a new paragraph with a text content
TextBuilder	parStyledContent(String text, TextStyle ts) Create a new paragraph with a text content
TextBuilder	span(String text) Create a span in the current paragraph.
TextBuilder	styledLink(String text, TextStyle ts, File file) Create a styled link in the current paragraph.
TextBuilder	styledLink(String text, TextStyle ts, String ref) Create a styled link in the current paragraph.
TextBuilder	styledLink(String text, TextStyle ts, Table table) Create a styled link in the current paragraph.
TextBuilder	styledLink(String text, TextStyle ts, URI uri) Create a styled link in the current paragraph.
TextBuilder	styledLink(String text, TextStyle ts, URL url) Create a styled link in the current paragraph.
TextBuilder	styledSpan(String text, TextStyle ts) Adds a TextStyle and text to the footer/header region specified by region.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static TextBuilder create()

Returns:

an empty text builder

build

public Text build()

Returns:

the text

par

public TextBuilder par()

Create a new paragraph

Returns:

this for fluent style

parContent

public TextBuilder parContent(String text)

Create a new paragraph with a text content

Parameters:

text - the text

Returns:

this for fluent style

parStyledContent

public TextBuilder parStyledContent(String text,
                                    TextStyle ts)

Create a new paragraph with a text content

Parameters:

text - the text

ts - the style

Returns:

this for fluent style

span

public TextBuilder span(String text)

Create a span in the current paragraph.

Parameters:

text - the text

Returns:

this for fluent style

link

public TextBuilder link(String text,
                        Table table)

Create a link in the current paragraph.

Parameters:

text - the text

table - the destination

Returns:

this for fluent style

styledLink

public TextBuilder styledLink(String text,
                              TextStyle ts,
                              Table table)

Create a styled link in the current paragraph.

Parameters:

text - the text

ts - the style

table - the destination

Returns:

this for fluent style

link

public TextBuilder link(String text,
                        File file)

Create a link in the current paragraph.

Parameters:

text - the text

file - the destination

Returns:

this for fluent style

styledLink

public TextBuilder styledLink(String text,
                              TextStyle ts,
                              File file)

Create a styled link in the current paragraph.

Parameters:

text - the text

ts - the style

file - the destination

Returns:

this for fluent style

link

public TextBuilder link(String text,
                        URL url)

Create a link in the current paragraph.

Parameters:

text - the text

url - the destination

Returns:

this for fluent style

styledLink

public TextBuilder styledLink(String text,
                              TextStyle ts,
                              URL url)

Create a styled link in the current paragraph.

Parameters:

text - the text

ts - the style

url - the destination

Returns:

this for fluent style

link

public TextBuilder link(String text,
                        URI uri)

Create a link in the current paragraph.

Parameters:

text - the text

uri - the destination

Returns:

this for fluent style

styledLink

public TextBuilder styledLink(String text,
                              TextStyle ts,
                              URI uri)

Create a styled link in the current paragraph.

Parameters:

text - the text

ts - the style

uri - the destination

Returns:

this for fluent style

link

public TextBuilder link(String text,
                        String ref)

Create a link in the current paragraph.

Parameters:

text - the text

ref - the destination

Returns:

this for fluent style

styledLink

public TextBuilder styledLink(String text,
                              TextStyle ts,
                              String ref)

Create a styled link in the current paragraph.

Parameters:

text - the text

ts - the style

ref - the destination

Returns:

this for fluent style

styledSpan

public TextBuilder styledSpan(String text,
                              TextStyle ts)

Adds a TextStyle and text to the footer/header region specified by region.
The paragraph to be used is paragraph.
The text will be shown in the order it was added with this function.

Parameters:

text - The string with the text

ts - The text style to be used

Returns:

this for fluent style