rtfdocumentsettings.html

IText PDF开发工具说明文档,使用很方便。

<DT><B>Since:</B></DT>
  <DD>2.1.1</DD>
</DL>
</DL>
<HR>

<A NAME="writereservhash"><!-- --></A><H3>
writereservhash</H3>
<PRE>
private <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>writereservhash</B></PRE>
<DL>
<DD>Document read password hash.
 Author: Howard Shank ([e-mail])
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.1.1</DD>
</DL>
</DL>
<HR>

<A NAME="readOnlyRecommended"><!-- --></A><H3>
readOnlyRecommended</H3>
<PRE>
private boolean <B>readOnlyRecommended</B></PRE>
<DL>
<DD>Document recommended to be opened in read only mode.
 Author: Howard Shank ([e-mail])
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.1.1</DD>
</DL>
</DL>
<HR>

<A NAME="imageWrittenAsBinary"><!-- --></A><H3>
imageWrittenAsBinary</H3>
<PRE>
private boolean <B>imageWrittenAsBinary</B></PRE>
<DL>
<DD>Images are written as binary data and not hex encoded.
 Author: Mark Hall ([e-mail])
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.1.1</DD>
</DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="RtfDocumentSettings(com.lowagie.text.rtf.document.RtfDocument)"><!-- --></A><H3>
RtfDocumentSettings</H3>
<PRE>
public <B>RtfDocumentSettings</B>(<A HREF="../../../../../com/lowagie/text/rtf/document/RtfDocument.html" title="class in com.lowagie.text.rtf.document">RtfDocument</A>&nbsp;document)</PRE>
<DL>
<DD>Constructs a new RtfDocumentSettings object.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>document</CODE> - The RtfDocument this RtfDocumentSettings belong to.</DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="isOutputDebugLineBreaks()"><!-- --></A><H3>
isOutputDebugLineBreaks</H3>
<PRE>
public boolean <B>isOutputDebugLineBreaks</B>()</PRE>
<DL>
<DD>Gets whether to output the line breaks for increased rtf document readability.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Whether to output line breaks.</DL>
</DD>
</DL>
<HR>

<A NAME="setOutputDebugLineBreaks(boolean)"><!-- --></A><H3>
setOutputDebugLineBreaks</H3>
<PRE>
public void <B>setOutputDebugLineBreaks</B>(boolean&nbsp;outputDebugLineBreaks)</PRE>
<DL>
<DD>Sets whether to output the line breaks for increased rtf document readability.
 Some line breaks may be added where the rtf specification demands it.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>outputDebugLineBreaks</CODE> - The outputDebugLineBreaks to set.</DL>
</DD>
</DL>
<HR>

<A NAME="isOutputTableRowDefinitionAfter()"><!-- --></A><H3>
isOutputTableRowDefinitionAfter</H3>
<PRE>
public boolean <B>isOutputTableRowDefinitionAfter</B>()</PRE>
<DL>
<DD>Gets whether the table row definition should also be written after the cell content.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Returns the outputTableRowDefinitionAfter.</DL>
</DD>
</DL>
<HR>

<A NAME="setOutputTableRowDefinitionAfter(boolean)"><!-- --></A><H3>
setOutputTableRowDefinitionAfter</H3>
<PRE>
public void <B>setOutputTableRowDefinitionAfter</B>(boolean&nbsp;outputTableRowDefinitionAfter)</PRE>
<DL>
<DD>Sets whether the table row definition should also be written after the cell content.
 This is recommended to be set to <code>true</code> if you need Word2000 compatiblity and
 <code>false</code> if the document should be opened in OpenOffice.org Writer.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>outputTableRowDefinitionAfter</CODE> - The outputTableRowDefinitionAfter to set.</DL>
</DD>
</DL>
<HR>

<A NAME="isAlwaysGenerateSoftLinebreaks()"><!-- --></A><H3>
isAlwaysGenerateSoftLinebreaks</H3>
<PRE>
public boolean <B>isAlwaysGenerateSoftLinebreaks</B>()</PRE>
<DL>
<DD>Gets whether all linebreaks inside Chunks are generated as soft linebreaks.
<P>
<DD><DL>

<DT><B>Returns:</B><DD><code>True</code> if soft linebreaks are generated, <code>false</code> for hard linebreaks.</DL>
</DD>
</DL>
<HR>

<A NAME="setAlwaysGenerateSoftLinebreaks(boolean)"><!-- --></A><H3>
setAlwaysGenerateSoftLinebreaks</H3>
<PRE>
public void <B>setAlwaysGenerateSoftLinebreaks</B>(boolean&nbsp;alwaysGenerateSoftLinebreaks)</PRE>
<DL>
<DD>Sets whether to always generate soft linebreaks.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>alwaysGenerateSoftLinebreaks</CODE> - Whether to always generate soft linebreaks.</DL>
</DD>
</DL>
<HR>

<A NAME="isAlwaysUseUnicode()"><!-- --></A><H3>
isAlwaysUseUnicode</H3>
<PRE>
public boolean <B>isAlwaysUseUnicode</B>()</PRE>
<DL>
<DD>Gets whether all characters bigger than 'z' are represented as unicode.
<P>
<DD><DL>

<DT><B>Returns:</B><DD><code>True</code> if unicode representation is used, <code>false</code> otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="setAlwaysUseUnicode(boolean)"><!-- --></A><H3>
setAlwaysUseUnicode</H3>
<PRE>
public void <B>setAlwaysUseUnicode</B>(boolean&nbsp;alwaysUseUnicode)</PRE>
<DL>
<DD>Sets whether to represent all characters bigger than 'z' as unicode.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>alwaysUseUnicode</CODE> - <code>True</code> to use unicode representation, <code>false</code> otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="registerParagraphStyle(com.lowagie.text.rtf.style.RtfParagraphStyle)"><!-- --></A><H3>
registerParagraphStyle</H3>
<PRE>
public void <B>registerParagraphStyle</B>(<A HREF="../../../../../com/lowagie/text/rtf/style/RtfParagraphStyle.html" title="class in com.lowagie.text.rtf.style">RtfParagraphStyle</A>&nbsp;rtfParagraphStyle)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>rtfParagraphStyle</CODE> - The RtfParagraphStyle to register.</DL>
</DD>
</DL>
<HR>

<A NAME="setDataCacheStyle(int)"><!-- --></A><H3>
setDataCacheStyle</H3>
<PRE>
public void <B>setDataCacheStyle</B>(int&nbsp;dataCacheStyle)</PRE>
<DL>
<DD>Sets the data cache style. This controls where the document is cached during
 generation. Two cache styles are supported:
 <ul>
   <li>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.</li>
   <li>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.</li>
 </ul>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dataCacheStyle</CODE> - The data cache style to set. Valid constants can be found
  in RtfDataCache.<DT><B>See Also:</B><DD><A HREF="../../../../../com/lowagie/text/rtf/document/output/RtfDataCache.html" title="interface in com.lowagie.text.rtf.document.output"><CODE>RtfDataCache</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getDataCacheStyle()"><!-- --></A><H3>
getDataCacheStyle</H3>
<PRE>
public int <B>getDataCacheStyle</B>()</PRE>
<DL>
<DD>Gets the current data cache style.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The current data cache style.</DL>
</DD>
</DL>
<HR>

<A NAME="isImagePDFConformance()"><!-- --></A><H3>
isImagePDFConformance</H3>
<PRE>
public boolean <B>isImagePDFConformance</B>()</PRE>
<DL>
<DD>Gets the current setting on image PDF conformance.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The current image PDF conformance.</DL>
</DD>
</DL>
<HR>

<A NAME="setImagePDFConformance(boolean)"><!-- --></A><H3>
setImagePDFConformance</H3>
<PRE>
public void <B>setImagePDFConformance</B>(boolean&nbsp;imagePDFConformance)</PRE>
<DL>
<DD>Sets the image PDF conformance setting. By default images will be added
 as if they were displayed with 72dpi. Set this to <code>false</code>
 if images should be generated with the Word default DPI setting.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>imagePDFConformance</CODE> - <code>True</code> if PDF equivalence is desired, <code>false</code>
   for the default Word display.</DL>
</DD>
</DL>
<HR>

<A NAME="isWriteImageScalingInformation()"><!-- --></A><H3>
isWriteImageScalingInformation</H3>
<PRE>
public boolean <B>isWriteImageScalingInformation</B>()</PRE>
<DL>
<DD>Gets whether to write scaling information for images.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Whether to write scaling information for images.</DL>
</DD>
</DL>
<HR>

<A NAME="setWriteImageScalingInformation(boolean)"><!-- --></A><H3>
setWriteImageScalingInformation</H3>
<PRE>
public void <B>setWriteImageScalingInformation</B>(boolean&nbsp;writeImageScalingInformation)</PRE>
<DL>
<DD>Sets whether image scaling information should be written. This needs to be set to <code>true</code>
 MS Word 2000, MS Word 97 and Word for Mac.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>writeImageScalingInformation</CODE> - Whether to write image scaling information.</DL>
</DD>
</DL>
<HR>

<A NAME="setOptionsForMSWord2000And97()"><!-- --></A><H3>
setOptionsForMSWord2000And97</H3>
<PRE>
public void <B>setOptionsForMSWord2000And97</B>()</PRE>
<DL>
<DD>Set the options required for RTF documents to display correctly in MS Word 2000
 and MS Word 97.
 Sets <code>outputTableRowDefinitionAfter = true</code> and <code>writeImageScalingInformation = true</code>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setOptionsForMSWordForMac()"><!-- --></A><H3>
setOptionsForMSWordForMac</H3>
<PRE>
public void <B>setOptionsForMSWordForMac</B>()</PRE>
<DL>
<DD>Set the options required for RTF documents to display correctly in MS Word for Mac.
 Sets <code>writeImageScalingInformation = true</code>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setOptionsForMSWordXP()"><!-- --></A><H3>
setOptionsForMSWordXP</H3>
<PRE>
public void <B>setOptionsForMSWordXP</B>()</PRE>
<DL>
<DD>Set the options required for RTF documents to display correctly in MS Word XP (2002).
 Sets <code>writeImageScalingInformation = false</code>.