com.scroogexhtml

Class ScroogeXHTML

java.lang.Object

com.scroogexhtml.converter.ScroogeXHTMLBase

com.scroogexhtml.converter.ScroogeXHTMLMain

com.scroogexhtml.ScroogeXHTML

All Implemented Interfaces:

Serializable

public class ScroogeXHTML
extends ScroogeXHTMLMain

ScroogeXHTML is the converter class which needs to be installed or instantiated in the application. It defines the conversion methods, which call the convert method in ScroogeXHTMLMain.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScroogeXHTML()

Method Summary

Modifier and Type	Method and Description
String	convert(ByteArrayInputStream rtf) Convert RTF input stream to XHTML / HTML string.
String	convert(File rtfFile) Convert RTF file to XHTML / HTML string.
void	convert(File rtfFile, File outFile) Convert RTF file to XHTML / HTML file, using UTF-8 output encoding.
void	convert(File rtfFile, File outFile, Charset charset) Convert RTF file to XHTML / HTML file, using the specified output charset.
String	convert(String rtf) Convert RTF string to XHTML / HTML string, using UTF-8 output format.
String	convert(String rtf, Charset charset) Convert RTF string to XHTML / HTML string, using the specified output charset.
void	convert(String inRtf, File outFile) Convert RTF string and write the result to the given file, using UTF-8 output format.
void	convert(String inRtf, File outFile, Charset charset) Convert RTF string and write the result to the given file, using the specified output charset.

Methods inherited from class com.scroogexhtml.converter.ScroogeXHTMLMain

addDefaultListeners

Methods inherited from class com.scroogexhtml.converter.ScroogeXHTMLBase

addPostProcessListener, getDefaultFontColor, getDefaultFontName, getDefaultFontSize, getDefaultLanguage, getDocumentTitle, getDocumentType, getFieldExpression, getFontReplacing, getFontSizeUnit, getFontStatistics, getIndentAmount, getMetaAuthor, getMetaDescription, getMetaGenerator, getMetaKeywords, getMetaViewport, getOutputProperties, getOutputProperty, getPictureAdapter, getPostProcessListeners, getReplaceFonts, getStyleSheetInclude, getStyleSheetLinks, getTabString, getVersion, isAddOuterHTML, isConvertAlignment, isConvertBookmarks, isConvertEmptyParagraphs, isConvertFields, isConvertFontBGColor, isConvertFontColor, isConvertFontHLColor, isConvertFontName, isConvertFontSize, isConvertFontStyle, isConvertFootnotes, isConvertHyperlinks, isConvertIndent, isConvertLanguage, isConvertPictures, isConvertTables, isIncludeDefaultFontStyle, nameAndVersion, removePostProcessListener, setAddOuterHTML, setConvertAlignment, setConvertBookmarks, setConvertEmptyParagraphs, setConvertFields, setConvertFontBGColor, setConvertFontColor, setConvertFontHLColor, setConvertFontName, setConvertFontSize, setConvertFontStyle, setConvertFootnotes, setConvertHyperlinks, setConvertIndent, setConvertLanguage, setConvertPictures, setConvertTables, setDefaultFontColor, setDefaultFontName, setDefaultFontSize, setDefaultLanguage, setDocumentTitle, setDocumentType, setFontReplacing, setFontSizeUnit, setFontStatistics, setIncludeDefaultFontStyle, setIndentAmount, setMetaAuthor, setMetaDescription, setMetaGenerator, setMetaKeywords, setMetaViewport, setOutputProperty, setPictureAdapter, setStyleSheetInclude, setStyleSheetLink, setTabString

Methods inherited from class java.lang.Object

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

Constructor Detail

ScroogeXHTML

public ScroogeXHTML()

Method Detail

convert

public String convert(String rtf,
                      Charset charset)

Convert RTF string to XHTML / HTML string, using the specified output charset.

Parameters:

rtf - the input RTF string

charset - the output charset

Returns:

XHTML / HTML result

Throws:

RuntimeException - If an IOException occurs in the internal methods, it will be logged and a RuntimeException will be thrown.

convert

public String convert(String rtf)

Convert RTF string to XHTML / HTML string, using UTF-8 output format.

Parameters:

rtf - the input RTF string

Returns:

XHTML / HTML result

Throws:

RuntimeException - If an IOException occurs in the internal methods, it will be logged and a RuntimeException will be thrown.

convert

public void convert(File rtfFile,
                    File outFile,
                    Charset charset)
             throws IOException

Convert RTF file to XHTML / HTML file, using the specified output charset.

Parameters:

rtfFile - the RTF file

outFile - the HTML/XHTML file

charset - the output file encoding

Throws:

IOException - conversion error

convert

public void convert(File rtfFile,
                    File outFile)
             throws IOException

Convert RTF file to XHTML / HTML file, using UTF-8 output encoding.

Parameters:

rtfFile - the RTF file

outFile - the output file

Throws:

IOException - conversion error

convert

public void convert(String inRtf,
                    File outFile,
                    Charset charset)
             throws IOException

Convert RTF string and write the result to the given file, using the specified output charset.

Parameters:

inRtf - the RTF input code

outFile - the output file

charset - the output charset

Throws:

IOException - conversion error

convert

public void convert(String inRtf,
                    File outFile)
             throws IOException

Convert RTF string and write the result to the given file, using UTF-8 output format.

Parameters:

inRtf - the RTF input code

outFile - the output file, UTF-8 encoded

Throws:

IOException - conversion error

convert

public String convert(File rtfFile)
               throws IOException

Convert RTF file to XHTML / HTML string.

Parameters:

rtfFile - the input RTF file

Returns:

XHTML / HTML string

Throws:

IOException - conversion error

convert

public String convert(ByteArrayInputStream rtf)

Convert RTF input stream to XHTML / HTML string.

Parameters:

rtf - The byte array input stream

Returns:

XHTML / HTML string

Throws:

RuntimeException - If an IOException occurs in the internal methods, it will be logged and a RuntimeException will be thrown.