rtfdocumentheader.html

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

<!-- ========= 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="RtfDocumentHeader(com.lowagie.text.rtf.document.RtfDocument)"><!-- --></A><H3>
RtfDocumentHeader</H3>
<PRE>
protected <B>RtfDocumentHeader</B>(<A HREF="../../../../../com/lowagie/text/rtf/document/RtfDocument.html" title="class in com.lowagie.text.rtf.document">RtfDocument</A>&nbsp;doc)</PRE>
<DL>
<DD>Constructs a RtfDocumentHeader for a RtfDocument
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>doc</CODE> - The RtfDocument this RtfDocumentHeader belongs 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="init()"><!-- --></A><H3>
init</H3>
<PRE>
protected void <B>init</B>()</PRE>
<DL>
<DD>initializes the RtfDocumentHeader.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<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;result)
                  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 contents of the document header area.
<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>result</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="writeSectionDefinition(java.io.OutputStream)"><!-- --></A><H3>
writeSectionDefinition</H3>
<PRE>
public void <B>writeSectionDefinition</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;result)</PRE>
<DL>
<DD>Writes the section definition data
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>result</CODE> - </DL>
</DD>
</DL>
<HR>

<A NAME="getFontNumber(com.lowagie.text.rtf.style.RtfFont)"><!-- --></A><H3>
getFontNumber</H3>
<PRE>
public int <B>getFontNumber</B>(<A HREF="../../../../../com/lowagie/text/rtf/style/RtfFont.html" title="class in com.lowagie.text.rtf.style">RtfFont</A>&nbsp;font)</PRE>
<DL>
<DD>Gets the number of the specified RtfFont
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>font</CODE> - The RtfFont for which to get the number
<DT><B>Returns:</B><DD>The number of the font</DL>
</DD>
</DL>
<HR>

<A NAME="getColorNumber(com.lowagie.text.rtf.style.RtfColor)"><!-- --></A><H3>
getColorNumber</H3>
<PRE>
public int <B>getColorNumber</B>(<A HREF="../../../../../com/lowagie/text/rtf/style/RtfColor.html" title="class in com.lowagie.text.rtf.style">RtfColor</A>&nbsp;color)</PRE>
<DL>
<DD>Gets the number of the specified RtfColor
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>color</CODE> - The RtfColor for which to get the number
<DT><B>Returns:</B><DD>The number of the color</DL>
</DD>
</DL>
<HR>

<A NAME="getListNumber(com.lowagie.text.rtf.list.RtfList)"><!-- --></A><H3>
getListNumber</H3>
<PRE>
public int <B>getListNumber</B>(<A HREF="../../../../../com/lowagie/text/rtf/list/RtfList.html" title="class in com.lowagie.text.rtf.list">RtfList</A>&nbsp;list)</PRE>
<DL>
<DD>Gets the number of the specified RtfList
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>list</CODE> - The RtfList for which to get the number
<DT><B>Returns:</B><DD>The number of the list</DL>
</DD>
</DL>
<HR>

<A NAME="getRtfParagraphStyle(java.lang.String)"><!-- --></A><H3>
getRtfParagraphStyle</H3>
<PRE>
public <A HREF="../../../../../com/lowagie/text/rtf/style/RtfParagraphStyle.html" title="class in com.lowagie.text.rtf.style">RtfParagraphStyle</A> <B>getRtfParagraphStyle</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;styleName)</PRE>
<DL>
<DD>Gets the RtfParagraphStyle with the given style name.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>styleName</CODE> - The style name of the RtfParagraphStyle to get.
<DT><B>Returns:</B><DD>The RtfParagraphStyle with the given style name or null.</DL>
</DD>
</DL>
<HR>

<A NAME="freeListNumber(com.lowagie.text.rtf.list.RtfList)"><!-- --></A><H3>
freeListNumber</H3>
<PRE>
public void <B>freeListNumber</B>(<A HREF="../../../../../com/lowagie/text/rtf/list/RtfList.html" title="class in com.lowagie.text.rtf.list">RtfList</A>&nbsp;list)</PRE>
<DL>
<DD>Removes a RtfList from the list table
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>list</CODE> - The RtfList to remove</DL>
</DD>
</DL>
<HR>

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

<DT><B>Returns:</B><DD>The RtfPageSetting object</DL>
</DD>
</DL>
<HR>

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

<A NAME="setHeader(com.lowagie.text.HeaderFooter)"><!-- --></A><H3>
setHeader</H3>
<PRE>
public void <B>setHeader</B>(<A HREF="../../../../../com/lowagie/text/HeaderFooter.html" title="class in com.lowagie.text">HeaderFooter</A>&nbsp;header)</PRE>
<DL>
<DD>Sets the current header to use
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>header</CODE> - The HeaderFooter to use as header</DL>
</DD>
</DL>
<HR>

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

<A NAME="convertHeaderFooter(com.lowagie.text.HeaderFooter, int)"><!-- --></A><H3>
convertHeaderFooter</H3>
<PRE>
private <A HREF="../../../../../com/lowagie/text/rtf/headerfooter/RtfHeaderFooterGroup.html" title="class in com.lowagie.text.rtf.headerfooter">RtfHeaderFooterGroup</A> <B>convertHeaderFooter</B>(<A HREF="../../../../../com/lowagie/text/HeaderFooter.html" title="class in com.lowagie.text">HeaderFooter</A>&nbsp;hf,
                                                 int&nbsp;type)</PRE>
<DL>
<DD>Converts a HeaderFooter into a RtfHeaderFooterGroup. Depending on which class
 the HeaderFooter is, the correct RtfHeaderFooterGroup is created.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>hf</CODE> - The HeaderFooter to convert.<DD><CODE>type</CODE> - Whether the conversion is being done on a footer or header
<DT><B>Returns:</B><DD>The converted RtfHeaderFooterGroup.<DT><B>See Also:</B><DD><A HREF="../../../../../com/lowagie/text/rtf/headerfooter/RtfHeaderFooter.html" title="class in com.lowagie.text.rtf.headerfooter"><CODE>RtfHeaderFooter</CODE></A>, 
<A HREF="../../../../../com/lowagie/text/rtf/headerfooter/RtfHeaderFooterGroup.html" title="class in com.lowagie.text.rtf.headerfooter"><CODE>RtfHeaderFooterGroup</CODE></A></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/RtfDocument.html" title="class in com.lowagie.text.rtf.document"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/lowagie/text/rtf/document/RtfDocumentSettings.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/RtfDocumentHeader.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="RtfDocumentHeader.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>