com.tutego.jrtf

Class Rtf

java.lang.Object

com.tutego.jrtf.Rtf

public class Rtf
extends Object

Main class to build and stream a RTF document.

Example how to generate a RTF file:

 Rtf.rtf().p( "Hello", bold("RTF") ).out( new FileWriter("out.rtf") );
 

Method Summary

Methods

Modifier and Type	Method and Description
Rtf	documentFormatting(RtfDocfmt... documentFormattings) Document formatting to specify the attributes of the document, such as pager with, margins or footnote placement.
Rtf	header(RtfHeader... headers) Sets RTF headers for the document.
Rtf	info(RtfInfo... infos) Writes information group, which contains information about the document.
CharSequence	out() Returns the RTF document as a CharSequence.
void	out(Appendable out) Writes the RTF document and send the output to an Appendable.
void	p(Object... texts) Appends a sequence of text in a new paragraph to the RTF document.
static Rtf	rtf() Creates a new RTF document.
Rtf	section(Collection<RtfPara> paragraphs) Creates a new section with paragraphs and appends them to the RTF document.
Rtf	section(RtfPara... paragraphs) Creates a new section with paragraphs and appends them to the RTF document.
Rtf	section(RtfSectionFormatAndHeaderFooter secfmtHdrftr, RtfPara... paragraphs) Creates a new formatted section with paragraphs and appends them to the RTF document.
static RtfTemplate	template(InputStream inputStream) Opens a RTF template for later variable substitution.
String	toString() Returns the RTF document as a String.

Methods inherited from class java.lang.Object

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

Method Detail

rtf

public static Rtf rtf()

Creates a new RTF document.

Returns:

The new RTF document.

header

public Rtf header(RtfHeader... headers)

Sets RTF headers for the document.

Parameters:

headers - Sequence of headers.

Returns:

this-reference.

info

public Rtf info(RtfInfo... infos)

Writes information group, which contains information about the document. This can include the title, author, keywords, comments, and other information specific to the file. This information is for use by a document-management utility.

Parameters:

infos - RTF info objects.

Returns:

this-reference.

documentFormatting

public Rtf documentFormatting(RtfDocfmt... documentFormattings)

Document formatting to specify the attributes of the document, such as pager with, margins or footnote placement.

Parameters:

documentFormattings - RTF document formattings.

Returns:

this-reference.

section

public Rtf section(RtfPara... paragraphs)

Creates a new section with paragraphs and appends them to the RTF document.

Parameters:

paragraphs - Paragraphs.

Returns:

this-reference.

section

public Rtf section(Collection<RtfPara> paragraphs)

Creates a new section with paragraphs and appends them to the RTF document.

Parameters:

paragraphs - Paragraphs.

Returns:

this-reference.

section

public Rtf section(RtfSectionFormatAndHeaderFooter secfmtHdrftr,
          RtfPara... paragraphs)

Creates a new formatted section with paragraphs and appends them to the RTF document.

Parameters:

secfmtHdrftr - Formattings. Might be null.

paragraphs - Paragraphs to be written.

Returns:

this-reference.

p

public void p(Object... texts)

Appends a sequence of text in a new paragraph to the RTF document. A convenience method which is equals to section(RtfPara.p(texts));.

Parameters:

texts - Text to put in paragraph.

out

public void out(Appendable out)

Writes the RTF document and send the output to an Appendable. This method closes the Appendable after writing if its of type Closeable.

Parameters:

out - Destination of this RTF output.

out

public CharSequence out()

Returns the RTF document as a CharSequence.

Returns:

The RTF document.

toString

public String toString()

Returns the RTF document as a String.

Overrides:

toString in class Object

Returns:

The RTF document.

template

public static RtfTemplate template(InputStream inputStream)

Opens a RTF template for later variable substitution.

Parameters:

inputStream - Source of the RTF file.

Returns:

Template object to make the substitutions on.