net.sourceforge.rtf

Class RTFTemplate

java.lang.Object

net.sourceforge.rtf.RTFTemplate

public class RTFTemplate
extends Object

Constructor Summary

Constructors

Constructor and Description
RTFTemplate()

Method Summary

Modifier and Type	Method and Description
IContext	getContext()
int	getGroupByPerPageBreak()
IRTFDocumentParser	getParser()
ITemplateEngine	getTemplateEngine()
RTFDocument	getTransformedDocument()
IRTFDocumentTransformer	getTransformer()
TransformerConfig	getTransformerConfig()
InputStream	getXmlFields()
void	initializeContext()
boolean	isCircularReferences()
RTFDocument	merge(File file) Merge.
RTFDocument	merge(String file) Merge.
RTFDocument	merge(Writer writer) Merge.
void	put(String key, Object value) Put a value for the given key.
void	setCircularReferences(boolean circularReferences)
void	setDefaultFormat(Class clazz, Format format) Set the default format for a given class.
void	setGlobalContext(IContext globalContext) Use a pre-populated Context.
void	setGroupByPerPageBreak(int groupByPerPageBreak)
void	setParser(IRTFDocumentParser parser)
void	setTemplate(File rtfSourceFile) Set the template to use
void	setTemplate(InputStream template) Set the template to use
void	setTemplate(Reader template) Set the template to use
void	setTemplateEngine(ITemplateEngine templateEngine)
void	setTransformedDocument(RTFDocument transformedDocument)
void	setTransformer(IRTFDocumentTransformer transformer)
void	setTransformerConfig(TransformerConfig transformerConfig)
void	setXmlFields(InputStream xmlFields)
RTFDocument	transform()
RTFDocument	transform(boolean convertBracketsLowLevelVelocityCode)

Methods inherited from class java.lang.Object

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

Constructor Detail

RTFTemplate

public RTFTemplate()

Method Detail

initializeContext

public void initializeContext()

getContext

public IContext getContext()

setGlobalContext

public void setGlobalContext(IContext globalContext)

Use a pre-populated Context. This method treats any previously populated keys in the context kindly, so it won't act unpredictably if this is called late

Parameters:

globalContext - a pre-populated Context object

setTemplate

public void setTemplate(File rtfSourceFile)
                 throws FileNotFoundException

Set the template to use

Parameters:

rtfSourceFile - the rtf Source File.

Throws:

FileNotFoundException - the exception.

setTemplate

public void setTemplate(InputStream template)

Set the template to use

Parameters:

template - the template.

setTemplate

public void setTemplate(Reader template)

Set the template to use

Parameters:

template - the template.

put

public void put(String key,
                Object value)

Put a value for the given key.

Parameters:

key - the key.

value - the value.

merge

public RTFDocument merge(String file)
                  throws Exception

Merge.

Parameters:

file - the file.

Returns:

the result.

Throws:

Exception - the exception.

merge

public RTFDocument merge(File file)
                  throws Exception

Merge.

Parameters:

file - file to merge into

Returns:

the result.

Throws:

Exception - the exception.

merge

public RTFDocument merge(Writer writer)
                  throws Exception

Merge.

Parameters:

writer - writer to merge into

Returns:

the result.

Throws:

Exception - the exception.

setDefaultFormat

public void setDefaultFormat(Class clazz,
                             Format format)

Set the default format for a given class.

Parameters:

clazz - class to set format for

format - format to use for instances of the given class

transform

public RTFDocument transform()
                      throws IOException,
                             SAXException

Throws:

IOException

SAXException

transform

public RTFDocument transform(boolean convertBracketsLowLevelVelocityCode)
                      throws IOException,
                             SAXException

Throws:

IOException

SAXException

getTemplateEngine

public ITemplateEngine getTemplateEngine()

setTemplateEngine

public void setTemplateEngine(ITemplateEngine templateEngine)

getTransformer

public IRTFDocumentTransformer getTransformer()

setTransformer

public void setTransformer(IRTFDocumentTransformer transformer)

setTransformerConfig

public void setTransformerConfig(TransformerConfig transformerConfig)

getTransformerConfig

public TransformerConfig getTransformerConfig()

getXmlFields

public InputStream getXmlFields()

setXmlFields

public void setXmlFields(InputStream xmlFields)

setTransformedDocument

public void setTransformedDocument(RTFDocument transformedDocument)

getTransformedDocument

public RTFDocument getTransformedDocument()

getGroupByPerPageBreak

public int getGroupByPerPageBreak()

setGroupByPerPageBreak

public void setGroupByPerPageBreak(int groupByPerPageBreak)

getParser

public IRTFDocumentParser getParser()

setParser

public void setParser(IRTFDocumentParser parser)

isCircularReferences

public boolean isCircularReferences()

setCircularReferences

public void setCircularReferences(boolean circularReferences)