net.sourceforge.rtf.handler

Class RTFDocumentHandler

java.lang.Object

net.sourceforge.rtf.parser.AbstractCoreRTFParser

net.sourceforge.rtf.parser.AbstractDefaultRTFParser

net.sourceforge.rtf.handler.RTFDocumentHandler

All Implemented Interfaces:

IRTFDocumentParser

public class RTFDocumentHandler
extends AbstractDefaultRTFParser
implements IRTFDocumentParser

RTF handler which implement AbstractDefaultRTFParser to create RTFDocument element RTF of RTF stream source.

Version:

1.0.0

Author:

Angelo ZERR

See Also:

RTFDocument

Constructor Summary

Constructors

Constructor and Description
RTFDocumentHandler()

Method Summary

Modifier and Type	Method and Description
protected void	endAnnotation()
protected void	endBookmark(String content) Implement endBookmark to end RTF bookmark element
protected void	endField() End field, compute name of field and update current RTF element to parent of field/
protected void	endGroup(char endGroupCharacter, int level) Implement endGroup event to add end group character to last row, last bookmark... parsed otherwise into current RTF element.
protected void	endRow(String content) Implement endRow to end RTF row element into current RTF element parsed.
protected void	endUserProperty(String content) Event end user property.
RTFDocument	getRTFDocument() Return RTFDocument populated by RTF handler.
protected void	handleText(String content) Implement handleText to add RTF content (different of RTF keyword) into current RTF element.
protected void	inTable(String content) Implement inTable - if currentElement is not row, then put it and the preceeding text from the last element to a new row, and set it as current element.
protected void	startAnnotation(String content) Event annotation.
protected void	startBookmark(String content) Implement startBookmark to start and add RTF bookmark element into current RTF element parsed.
protected void	startField(String content) Implement startField to start and add RTF field element into current RTF element parsed.
protected void	startGroup(char startGroupCharacter, int level) Implement startGroup event to create RTF root element RTFDocument on first level and store start group character.
protected void	startPage(String content) Implement startPage to start and add RTF page break element into current RTF element parsed.
protected void	startRow(String content) Implement startRow to start and add RTF row element into current RTF element parsed.
protected void	startUserProperty(String content) Event start user property.

Methods inherited from class net.sourceforge.rtf.parser.AbstractDefaultRTFParser

handleKeyword

Methods inherited from class net.sourceforge.rtf.parser.AbstractCoreRTFParser

getLevel, parse, parse

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.rtf.IRTFDocumentParser

parse, parse

Constructor Detail

RTFDocumentHandler

public RTFDocumentHandler()

Method Detail

startGroup

protected void startGroup(char startGroupCharacter,
                          int level)
                   throws IOException

Implement startGroup event to create RTF root element RTFDocument on first level and store start group character.

Specified by:

startGroup in class AbstractCoreRTFParser

Parameters:

startGroupCharacter - start group character {.

level - of current group.

Throws:

IOException - the exception.

endGroup

protected void endGroup(char endGroupCharacter,
                        int level)
                 throws IOException

Implement endGroup event to add end group character to last row, last bookmark... parsed otherwise into current RTF element.

Specified by:

endGroup in class AbstractCoreRTFParser

Parameters:

endGroupCharacter - end group character }.

level - of current group.

Throws:

IOException - the exception.

startRow

protected void startRow(String content)
                 throws IOException

Implement startRow to start and add RTF row element into current RTF element parsed.

Specified by:

startRow in class AbstractDefaultRTFParser

Parameters:

content - RTF start row keyword \trowd.

Throws:

IOException - the exception.

endRow

protected void endRow(String content)
               throws IOException

Implement endRow to end RTF row element into current RTF element parsed.

Specified by:

endRow in class AbstractDefaultRTFParser

Parameters:

content - RTF end row keyword \row.

Throws:

IOException - the exception.

inTable

protected void inTable(String content)
                throws IOException

Implement inTable - if currentElement is not row, then put it and the preceeding text from the last element to a new row, and set it as current element.

Specified by:

inTable in class AbstractDefaultRTFParser

Parameters:

content - RTF in table keyword \intbl

Throws:

IOException - the exception.

startField

protected void startField(String content)
                   throws IOException

Implement startField to start and add RTF field element into current RTF element parsed.

Specified by:

startField in class AbstractDefaultRTFParser

Parameters:

content - RTF start field keyword \field.

Throws:

IOException - the exception.

endField

protected void endField()
                 throws IOException

End field, compute name of field and update current RTF element to parent of field/

Throws:

IOException - the exception.

startBookmark

protected void startBookmark(String content)
                      throws IOException

Implement startBookmark to start and add RTF bookmark element into current RTF element parsed.

Specified by:

startBookmark in class AbstractDefaultRTFParser

Parameters:

content - RTF start bookmark keyword \bkmstart.

Throws:

IOException - the exception.

endBookmark

protected void endBookmark(String content)
                    throws IOException

Implement endBookmark to end RTF bookmark element

Specified by:

endBookmark in class AbstractDefaultRTFParser

Parameters:

content - RTF end bookmark keyword \bkmend.

Throws:

IOException - the exception.

startPage

protected void startPage(String content)
                  throws IOException

Implement startPage to start and add RTF page break element into current RTF element parsed.

Specified by:

startPage in class AbstractDefaultRTFParser

Parameters:

content - RTF start page keyword \page.

Throws:

IOException - the exception.

startUserProperty

protected void startUserProperty(String content)
                          throws IOException

Description copied from class: AbstractDefaultRTFParser

Event start user property. This event is launched when RTF keyword \propname is found.

Specified by:

startUserProperty in class AbstractDefaultRTFParser

Parameters:

content - RTF start user property keyword \propname.

Throws:

IOException - the exception.

endUserProperty

protected void endUserProperty(String content)
                        throws IOException

Description copied from class: AbstractDefaultRTFParser

Event end user property. This event is launched when RTF keyword \staticval is found.

Specified by:

endUserProperty in class AbstractDefaultRTFParser

Parameters:

content - RTF end user property keyword \staticval.

Throws:

IOException - the exception.

startAnnotation

protected void startAnnotation(String content)
                        throws IOException

Description copied from class: AbstractDefaultRTFParser

Event annotation. This event is launched when RTF keyword \annotation is found.

Specified by:

startAnnotation in class AbstractDefaultRTFParser

Parameters:

content - RTF annotation keyword \annotation.

Throws:

IOException - the exception.

endAnnotation

protected void endAnnotation()

handleText

protected void handleText(String content)
                   throws IOException

Implement handleText to add RTF content (different of RTF keyword) into current RTF element.

Specified by:

handleText in class AbstractDefaultRTFParser

Parameters:

content - RTF code.

Throws:

IOException - the exception.

getRTFDocument

public RTFDocument getRTFDocument()

Return RTFDocument populated by RTF handler.

Specified by:

getRTFDocument in interface IRTFDocumentParser

Returns:

the result.