pdfoutline.html

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

initOutline</H3>
<PRE>
void <B>initOutline</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfOutline.html" title="class in com.lowagie.text.pdf">PdfOutline</A>&nbsp;parent,
                 <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;title,
                 boolean&nbsp;open)</PRE>
<DL>
<DD>Helper for the constructors.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parent</CODE> - the parent outline<DD><CODE>title</CODE> - the title for this outline<DD><CODE>open</CODE> - <CODE>true</CODE> if the children are visible</DL>
</DD>
</DL>
<HR>

<A NAME="setIndirectReference(com.lowagie.text.pdf.PdfIndirectReference)"><!-- --></A><H3>
setIndirectReference</H3>
<PRE>
public void <B>setIndirectReference</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfIndirectReference.html" title="class in com.lowagie.text.pdf">PdfIndirectReference</A>&nbsp;reference)</PRE>
<DL>
<DD>Sets the indirect reference of this <CODE>PdfOutline</CODE>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reference</CODE> - the <CODE>PdfIndirectReference</CODE> to this outline.</DL>
</DD>
</DL>
<HR>

<A NAME="indirectReference()"><!-- --></A><H3>
indirectReference</H3>
<PRE>
public <A HREF="../../../../com/lowagie/text/pdf/PdfIndirectReference.html" title="class in com.lowagie.text.pdf">PdfIndirectReference</A> <B>indirectReference</B>()</PRE>
<DL>
<DD>Gets the indirect reference of this <CODE>PdfOutline</CODE>.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the <CODE>PdfIndirectReference</CODE> to this outline.</DL>
</DD>
</DL>
<HR>

<A NAME="parent()"><!-- --></A><H3>
parent</H3>
<PRE>
public <A HREF="../../../../com/lowagie/text/pdf/PdfOutline.html" title="class in com.lowagie.text.pdf">PdfOutline</A> <B>parent</B>()</PRE>
<DL>
<DD>Gets the parent of this <CODE>PdfOutline</CODE>.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the <CODE>PdfOutline</CODE> that is the parent of this outline.</DL>
</DD>
</DL>
<HR>

<A NAME="setDestinationPage(com.lowagie.text.pdf.PdfIndirectReference)"><!-- --></A><H3>
setDestinationPage</H3>
<PRE>
public boolean <B>setDestinationPage</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfIndirectReference.html" title="class in com.lowagie.text.pdf">PdfIndirectReference</A>&nbsp;pageReference)</PRE>
<DL>
<DD>Set the page of the <CODE>PdfDestination</CODE>-object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pageReference</CODE> - indirect reference to the page
<DT><B>Returns:</B><DD><CODE>true</CODE> if this page was set as the <CODE>PdfDestination</CODE>-page.</DL>
</DD>
</DL>
<HR>

<A NAME="getPdfDestination()"><!-- --></A><H3>
getPdfDestination</H3>
<PRE>
public <A HREF="../../../../com/lowagie/text/pdf/PdfDestination.html" title="class in com.lowagie.text.pdf">PdfDestination</A> <B>getPdfDestination</B>()</PRE>
<DL>
<DD>Gets the destination for this outline.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the destination</DL>
</DD>
</DL>
<HR>

<A NAME="getCount()"><!-- --></A><H3>
getCount</H3>
<PRE>
int <B>getCount</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setCount(int)"><!-- --></A><H3>
setCount</H3>
<PRE>
void <B>setCount</B>(int&nbsp;count)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="level()"><!-- --></A><H3>
level</H3>
<PRE>
public int <B>level</B>()</PRE>
<DL>
<DD>returns the level of this outline.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a level</DL>
</DD>
</DL>
<HR>

<A NAME="toPdf(com.lowagie.text.pdf.PdfWriter, java.io.OutputStream)"><!-- --></A><H3>
toPdf</H3>
<PRE>
public void <B>toPdf</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfWriter.html" title="class in com.lowagie.text.pdf">PdfWriter</A>&nbsp;writer,
                  <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;os)
           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>Returns the PDF representation of this <CODE>PdfOutline</CODE>.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/lowagie/text/pdf/PdfDictionary.html#toPdf(com.lowagie.text.pdf.PdfWriter, java.io.OutputStream)">toPdf</A></CODE> in class <CODE><A HREF="../../../../com/lowagie/text/pdf/PdfDictionary.html" title="class in com.lowagie.text.pdf">PdfDictionary</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>writer</CODE> - the encryption information<DD><CODE>os</CODE> - 
<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="addKid(com.lowagie.text.pdf.PdfOutline)"><!-- --></A><H3>
addKid</H3>
<PRE>
public void <B>addKid</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfOutline.html" title="class in com.lowagie.text.pdf">PdfOutline</A>&nbsp;outline)</PRE>
<DL>
<DD>Adds a kid to the outline
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>outline</CODE> - </DL>
</DD>
</DL>
<HR>

<A NAME="getKids()"><!-- --></A><H3>
getKids</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</A> <B>getKids</B>()</PRE>
<DL>
<DD>Returns the kids of this outline
<P>
<DD><DL>

<DT><B>Returns:</B><DD>an ArrayList with PdfOutlines</DL>
</DD>
</DL>
<HR>

<A NAME="setKids(java.util.ArrayList)"><!-- --></A><H3>
setKids</H3>
<PRE>
public void <B>setKids</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</A>&nbsp;kids)</PRE>
<DL>
<DD>Sets the kids of this outline
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>kids</CODE> - </DL>
</DD>
</DL>
<HR>

<A NAME="getTag()"><!-- --></A><H3>
getTag</H3>
<PRE>
public <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>getTag</B>()</PRE>
<DL>
<DD>Getter for property tag.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Value of property tag.</DL>
</DD>
</DL>
<HR>

<A NAME="setTag(java.lang.String)"><!-- --></A><H3>
setTag</H3>
<PRE>
public void <B>setTag</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;tag)</PRE>
<DL>
<DD>Setter for property tag.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>tag</CODE> - New value of property tag.</DL>
</DD>
</DL>
<HR>

<A NAME="getTitle()"><!-- --></A><H3>
getTitle</H3>
<PRE>
public <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>getTitle</B>()</PRE>
<DL>
<DD>Gets the title of this outline
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the title as a String</DL>
</DD>
</DL>
<HR>

<A NAME="setTitle(java.lang.String)"><!-- --></A><H3>
setTitle</H3>
<PRE>
public void <B>setTitle</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;title)</PRE>
<DL>
<DD>Sets the title of this outline
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>title</CODE> - </DL>
</DD>
</DL>
<HR>

<A NAME="isOpen()"><!-- --></A><H3>
isOpen</H3>
<PRE>
public boolean <B>isOpen</