The RtfDocumentSettings contains output specific settings. These settings modify
how the actual document is then generated and some settings may mean that some
RTF readers can't read the document or render it wrongly.
version: $Id: RtfDocumentSettings.java 2776 2007-05-23 20:01:40Z hallm $ author: Mark Hall (mhall@edu.uni-klu.ac.at) author: Thomas Bickel (tmb99@inode.at)
setImagePDFConformance(boolean imagePDFConformance) Sets the image PDF conformance setting.
public void
setOptionsForMSWord2000And97() Set the options required for RTF documents to display correctly in MS Word 2000
and MS Word 97.
public void
setOptionsForMSWordForMac() Set the options required for RTF documents to display correctly in MS Word for Mac.
public void
setOptionsForMSWordXP() Set the options required for RTF documents to display correctly in MS Word XP (2002).
public void
setOptionsForOpenOfficeOrg() Set the options required for RTF documents to display correctly in OpenOffice.Org
Writer.
public void
setOutputDebugLineBreaks(boolean outputDebugLineBreaks) Sets whether to output the line breaks for increased rtf document readability.
public void
setOutputTableRowDefinitionAfter(boolean outputTableRowDefinitionAfter) Sets whether the table row definition should also be written after the cell content.
public void
setWriteImageScalingInformation(boolean writeImageScalingInformation) Sets whether image scaling information should be written.
Registers the RtfParagraphStyle for further use in the document. This does not need to be
done for the default styles in the RtfParagraphStyle object. Those are added automatically.
Parameters: rtfParagraphStyle - The RtfParagraphStyle to register.
setAlwaysGenerateSoftLinebreaks
public void setAlwaysGenerateSoftLinebreaks(boolean alwaysGenerateSoftLinebreaks)(Code)
Sets whether to always generate soft linebreaks.
Parameters: alwaysGenerateSoftLinebreaks - Whether to always generate soft linebreaks.
setAlwaysUseUnicode
public void setAlwaysUseUnicode(boolean alwaysUseUnicode)(Code)
Sets whether to represent all characters bigger than 'z' as unicode.
Parameters: alwaysUseUnicode - True to use unicode representation, false otherwise.
setDataCacheStyle
public void setDataCacheStyle(int dataCacheStyle)(Code)
Sets the data cache style. This controls where the document is cached during
generation. Two cache styles are supported:
RtfDataCache.CACHE_MEMORY: The document is cached in memory. This is fast,
but places a limit on how big the document can get before causing
OutOfMemoryExceptions.
RtfDataCache.CACHE_DISK: The document is cached on disk. This is slower
than the CACHE_MEMORY setting, but the document size is now only constrained
by the amount of free disk space.
public void setImagePDFConformance(boolean imagePDFConformance)(Code)
Sets the image PDF conformance setting. By default images will be added
as if they were displayed with 72dpi. Set this to false
if images should be generated with the Word default DPI setting.
Parameters: imagePDFConformance - True if PDF equivalence is desired, falsefor the default Word display.
Set the options required for RTF documents to display correctly in MS Word 2000
and MS Word 97.
Sets outputTableRowDefinitionAfter = true and writeImageScalingInformation = true.
Set the options required for RTF documents to display correctly in OpenOffice.Org
Writer.
Sets outputTableRowDefinitionAfter = false.
setOutputDebugLineBreaks
public void setOutputDebugLineBreaks(boolean outputDebugLineBreaks)(Code)
Sets whether to output the line breaks for increased rtf document readability.
Some line breaks may be added where the rtf specification demands it.
Parameters: outputDebugLineBreaks - The outputDebugLineBreaks to set.
setOutputTableRowDefinitionAfter
public void setOutputTableRowDefinitionAfter(boolean outputTableRowDefinitionAfter)(Code)
Sets whether the table row definition should also be written after the cell content.
This is recommended to be set to true if you need Word2000 compatiblity and
false if the document should be opened in OpenOffice.org Writer.
Parameters: outputTableRowDefinitionAfter - The outputTableRowDefinitionAfter to set.
setWriteImageScalingInformation
public void setWriteImageScalingInformation(boolean writeImageScalingInformation)(Code)
Sets whether image scaling information should be written. This needs to be set to true
MS Word 2000, MS Word 97 and Word for Mac.
Parameters: writeImageScalingInformation - Whether to write image scaling information.