com.lowagie.text.rtf.document
public class RtfDocumentSettings extends Object
Version: $Id: RtfDocumentSettings.java 2776 2007-05-23 20:01:40Z hallm $
Field Summary | |
---|---|
boolean | alwaysGenerateSoftLinebreaks
Whether to always generate soft linebreaks for \n in Chunks. |
boolean | alwaysUseUnicode
Whether to always translate characters past 'z' into unicode representations. |
int | dataCacheStyle
How to cache the document during generation. |
RtfDocument | document
The RtfDocument this RtfDocumentSettings belongs to. |
boolean | imagePDFConformance
Whether images should be written in order to mimick the PDF output. |
boolean | outputDebugLineBreaks
Whether to output the line breaks that make the rtf document source more readable. |
boolean | outputTableRowDefinitionAfter
Whether to also output the table row definition after the cell content. |
boolean | writeImageScalingInformation
Whether to write image scaling information. |
Constructor Summary | |
---|---|
RtfDocumentSettings(RtfDocument document)
Constructs a new RtfDocumentSettings object.
|
Method Summary | |
---|---|
int | getDataCacheStyle()
Gets the current data cache style.
|
boolean | isAlwaysGenerateSoftLinebreaks()
Gets whether all linebreaks inside Chunks are generated as soft linebreaks.
|
boolean | isAlwaysUseUnicode()
Gets whether all characters bigger than 'z' are represented as unicode.
|
boolean | isImagePDFConformance()
Gets the current setting on image PDF conformance.
|
boolean | isOutputDebugLineBreaks()
Gets whether to output the line breaks for increased rtf document readability.
|
boolean | isOutputTableRowDefinitionAfter()
Gets whether the table row definition should also be written after the cell content.
|
boolean | isWriteImageScalingInformation()
Gets whether to write scaling information for images.
|
void | registerParagraphStyle(RtfParagraphStyle rtfParagraphStyle)
Registers the RtfParagraphStyle for further use in the document. |
void | setAlwaysGenerateSoftLinebreaks(boolean alwaysGenerateSoftLinebreaks)
Sets whether to always generate soft linebreaks.
|
void | setAlwaysUseUnicode(boolean alwaysUseUnicode)
Sets whether to represent all characters bigger than 'z' as unicode.
|
void | setDataCacheStyle(int dataCacheStyle)
Sets the data cache style. |
void | setImagePDFConformance(boolean imagePDFConformance)
Sets the image PDF conformance setting. |
void | setOptionsForMSWord2000And97()
Set the options required for RTF documents to display correctly in MS Word 2000
and MS Word 97.
|
void | setOptionsForMSWordForMac()
Set the options required for RTF documents to display correctly in MS Word for Mac.
|
void | setOptionsForMSWordXP()
Set the options required for RTF documents to display correctly in MS Word XP (2002).
|
void | setOptionsForOpenOfficeOrg()
Set the options required for RTF documents to display correctly in OpenOffice.Org
Writer.
|
void | setOutputDebugLineBreaks(boolean outputDebugLineBreaks)
Sets whether to output the line breaks for increased rtf document readability.
|
void | setOutputTableRowDefinitionAfter(boolean outputTableRowDefinitionAfter)
Sets whether the table row definition should also be written after the cell content.
|
void | setWriteImageScalingInformation(boolean writeImageScalingInformation)
Sets whether image scaling information should be written. |
Parameters: document The RtfDocument this RtfDocumentSettings belong to.
Returns: The current data cache style.
Returns: True
if soft linebreaks are generated, false
for hard linebreaks.
Returns: True
if unicode representation is used, false
otherwise.
Returns: The current image PDF conformance.
Returns: Whether to output line breaks.
Returns: Returns the outputTableRowDefinitionAfter.
Returns: Whether to write scaling information for images.
Parameters: rtfParagraphStyle The RtfParagraphStyle to register.
Parameters: alwaysGenerateSoftLinebreaks Whether to always generate soft linebreaks.
Parameters: alwaysUseUnicode True
to use unicode representation, false
otherwise.
Parameters: dataCacheStyle The data cache style to set. Valid constants can be found in RtfDataCache.
See Also: RtfDataCache
false
if images should be generated with the Word default DPI setting.
Parameters: imagePDFConformance True
if PDF equivalence is desired, false
for the default Word display.
outputTableRowDefinitionAfter = true
and writeImageScalingInformation = true
.writeImageScalingInformation = true
.writeImageScalingInformation = false
.outputTableRowDefinitionAfter = false
.Parameters: outputDebugLineBreaks The outputDebugLineBreaks to set.
true
if you need Word2000 compatiblity and
false
if the document should be opened in OpenOffice.org Writer.
Parameters: outputTableRowDefinitionAfter The outputTableRowDefinitionAfter to set.
true
MS Word 2000, MS Word 97 and Word for Mac.
Parameters: writeImageScalingInformation Whether to write image scaling information.