com.rtfparserkit.parser

Interface IRtfListener

All Known Implementing Classes:

AbstractTextConverter, RtfDumpListener, RtfListenerAdaptor, StandardRtfParser, StreamTextConverter, StringTextConverter

public interface IRtfListener

Listener interface implemented by classes to receive event from an RTF parser.

Method Summary

Modifier and Type	Method and Description
void	processBinaryBytes(byte[] data) Event raised by an RTF parser to pass binary bytes.
void	processCharacterBytes(byte[] data) Event raised by the raw RTF parser to pass bytes representing characters.
void	processCommand(Command command, int parameter, boolean hasParameter, boolean optional) Event raised by the RTF parser detailing a command read from the file.
void	processDocumentEnd() Event raised when the parser reaches the end of the document.
void	processDocumentStart() Event raised when the parser starts to read the document.
void	processGroupEnd() Event raised when the end of a group is encountered.
void	processGroupStart() Event raised when the stat of a group is encountered.
void	processString(String string) Event raised by the RTF parser to pass string data.

Method Detail

processDocumentStart

void processDocumentStart()

Event raised when the parser starts to read the document.

processDocumentEnd

void processDocumentEnd()

Event raised when the parser reaches the end of the document.

processGroupStart

void processGroupStart()

Event raised when the stat of a group is encountered.

processGroupEnd

void processGroupEnd()

Event raised when the end of a group is encountered.

processCharacterBytes

void processCharacterBytes(byte[] data)

Event raised by the raw RTF parser to pass bytes representing characters. Note that these bytes will be "as read" from the RTF file, and have not been processed to account for the current encoding.

processBinaryBytes

void processBinaryBytes(byte[] data)

Event raised by an RTF parser to pass binary bytes.

processString

void processString(String string)

Event raised by the RTF parser to pass string data. Note that the string has been created with the appropriate encoding and no further processing will be required.

processCommand

void processCommand(Command command,
                    int parameter,
                    boolean hasParameter,
                    boolean optional)

Event raised by the RTF parser detailing a command read from the file. The parameter argument details the optional integer parameter associated with the command. If the hasParameter flag is false, the parameter argument can be ignored. If the optional flag is set, this is a command which RTF readers can choose not to implement.