rtfdocument.html

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

private static final byte[] <B>FSC_HEX_PREFIX</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>

<A NAME="FSC_UNI_PREFIX"><!-- --></A><H3>
FSC_UNI_PREFIX</H3>
<PRE>
private static final byte[] <B>FSC_UNI_PREFIX</B></PRE>
<DL>
<DL>
</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="RtfDocument()"><!-- --></A><H3>
RtfDocument</H3>
<PRE>
public <B>RtfDocument</B>()</PRE>
<DL>
<DD>The default constructor for a RtfDocument
<P>
</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="writeContent(java.io.OutputStream)"><!-- --></A><H3>
writeContent</H3>
<PRE>
public void <B>writeContent</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A>&nbsp;out)
                  throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>unused
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/lowagie/text/rtf/RtfBasicElement.html#writeContent(java.io.OutputStream)">writeContent</A></CODE> in interface <CODE><A HREF="../../../../../com/lowagie/text/rtf/RtfBasicElement.html" title="interface in com.lowagie.text.rtf">RtfBasicElement</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/lowagie/text/rtf/RtfElement.html#writeContent(java.io.OutputStream)">writeContent</A></CODE> in class <CODE><A HREF="../../../../../com/lowagie/text/rtf/RtfElement.html" title="class in com.lowagie.text.rtf">RtfElement</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>out</CODE> - The <code>OutputStream</code> to write the content to
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="writeDocument(java.io.OutputStream)"><!-- --></A><H3>
writeDocument</H3>
<PRE>
public void <B>writeDocument</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A>&nbsp;out)</PRE>
<DL>
<DD>Writes the document
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>out</CODE> - The <code>OutputStream</code> to write the RTF document to.</DL>
</DD>
</DL>
<HR>

<A NAME="open()"><!-- --></A><H3>
open</H3>
<PRE>
public void <B>open</B>()</PRE>
<DL>
<DD>Opens the RtfDocument and initializes the data cache. If the data cache is
 set to CACHE_DISK, but the cache cannot be initialized then the memory cache
 is used.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="add(com.lowagie.text.rtf.RtfBasicElement)"><!-- --></A><H3>
add</H3>
<PRE>
public void <B>add</B>(<A HREF="../../../../../com/lowagie/text/rtf/RtfBasicElement.html" title="interface in com.lowagie.text.rtf">RtfBasicElement</A>&nbsp;element)</PRE>
<DL>
<DD>Adds an element to the rtf document
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>element</CODE> - The element to add</DL>
</DD>
</DL>
<HR>

<A NAME="getMapper()"><!-- --></A><H3>
getMapper</H3>
<PRE>
public <A HREF="../../../../../com/lowagie/text/rtf/RtfMapper.html" title="class in com.lowagie.text.rtf">RtfMapper</A> <B>getMapper</B>()</PRE>
<DL>
<DD>Gets the RtfMapper object of this RtfDocument
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The RtfMapper</DL>
</DD>
</DL>
<HR>

<A NAME="getRandomInt()"><!-- --></A><H3>
getRandomInt</H3>
<PRE>
public int <B>getRandomInt</B>()</PRE>
<DL>
<DD>Generates a random integer that is unique with respect to the document.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>A random int</DL>
</DD>
</DL>
<HR>

<A NAME="getDocumentHeader()"><!-- --></A><H3>
getDocumentHeader</H3>
<PRE>
public <A HREF="../../../../../com/lowagie/text/rtf/document/RtfDocumentHeader.html" title="class in com.lowagie.text.rtf.document">RtfDocumentHeader</A> <B>getDocumentHeader</B>()</PRE>
<DL>
<DD>Gets the RtfDocumentHeader of this RtfDocument
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The RtfDocumentHeader of this RtfDocument</DL>
</DD>
</DL>
<HR>

<A NAME="filterSpecialChar(java.io.OutputStream, java.lang.String, boolean, boolean)"><!-- --></A><H3>
filterSpecialChar</H3>
<PRE>
public void <B>filterSpecialChar</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A>&nbsp;out,
                              <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>&nbsp;str,
                              boolean&nbsp;useHex,
                              boolean&nbsp;softLineBreaks)
                       throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Writes the given string to the given <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io"><CODE>OutputStream</CODE></A> encoding the string characters.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>out</CODE> - destination OutputStream<DD><CODE>str</CODE> - string to write<DD><CODE>useHex</CODE> - if <code>true</code> hex encoding characters is preferred to unicode encoding if possible<DD><CODE>softLineBreaks</CODE> - if <code>true</code> return characters are written as soft line breaks
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="subMatch(java.lang.String, int, byte[])"><!-- --></A><H3>
subMatch</H3>
<PRE>
private static boolean <B>subMatch</B>(<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>&nbsp;str,
                                int&nbsp;soff,
                                byte[]&nbsp;m)</PRE>
<DL>
<DD>Returns <code>true</code> if <tt>m.length</tt> characters in <tt>str</tt>, starting at offset <tt>soff</tt>
 match the bytes in the given array <tt>m</tt>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to search for a match<DD><CODE>soff</CODE> - the starting offset in str<DD><CODE>m</CODE> - the array to match
<DT><B>Returns:</B><DD><code>true</code> if there is match</DL>
</DD>
</DL>
<HR>

<A NAME="setAutogenerateTOCEntries(boolean)"><!-- --></A><H3>
setAutogenerateTOCEntries</H3>
<PRE>
public void <B>setAutogenerateTOCEntries</B>(boolean&nbsp;autogenerate)</PRE>
<DL>
<DD>Whether to automagically generate table of contents entries when
 adding Chapters or Sections.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>autogenerate</CODE> - Whether to automatically generate TOC entries</DL>
</DD>
</DL>
<HR>

<A NAME="getAutogenerateTOCEntries()"><!-- --></A><H3>
getAutogenerateTOCEntries</H3>
<PRE>
public boolean <B>getAutogenerateTOCEntries</B>()</PRE>
<DL>
<DD>Get whether to automatically generate table of contents entries
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Whether to automatically generate TOC entries</DL>
</DD>
</DL>
<HR>

<A NAME="getDocumentSettings()"><!-- --></A><H3>
getDocumentSettings</H3>
<PRE>
public <A HREF="../../../../../com/lowagie/text/rtf/document/RtfDocumentSettings.html" title="class in com.lowagie.text.rtf.document">RtfDocumentSettings</A> <B>getDocumentSettings</B>()</PRE>
<DL>
<DD>Gets the RtfDocumentSettings that specify how the rtf document is generated.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The current RtfDocumentSettings.</DL>
</DD>
</DL>
<HR>

<A NAME="getLastElementWritten()"><!-- --></A><H3>
getLastElementWritten</H3>
<PRE>
public <A HREF="../../../../../com/lowagie/text/rtf/RtfBasicElement.html" title="interface in com.lowagie.text.rtf">RtfBasicElement</A> <B>getLastElementWritten</B>()</PRE>
<DL>
<DD>Gets the last RtfBasicElement that was directly added to the RtfDocument.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The last RtfBasicElement that was directly added to the RtfDocument.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Hosted by <a href="http://www.hostbasket.com/">Hostbasket</a></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../com/lowagie/text/rtf/document/RtfCodePage.html" title="class in com.lowagie.text.rtf.document"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/lowagie/text/rtf/document/RtfDocumentHeader.html" title="class in com.lowagie.text.rtf.document"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html?com/lowagie/text/rtf/document/RtfDocument.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="RtfDocument.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>