simplebookmark.html

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

<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="bookmarkDepth(com.lowagie.text.pdf.PdfReader, com.lowagie.text.pdf.PdfDictionary, com.lowagie.text.pdf.IntHashtable)"><!-- --></A><H3>
bookmarkDepth</H3>
<PRE>
private static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A> <B>bookmarkDepth</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfReader.html" title="class in com.lowagie.text.pdf">PdfReader</A>&nbsp;reader,
                                  <A HREF="../../../../com/lowagie/text/pdf/PdfDictionary.html" title="class in com.lowagie.text.pdf">PdfDictionary</A>&nbsp;outline,
                                  <A HREF="../../../../com/lowagie/text/pdf/IntHashtable.html" title="class in com.lowagie.text.pdf">IntHashtable</A>&nbsp;pages)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="mapGotoBookmark(java.util.HashMap, com.lowagie.text.pdf.PdfObject, com.lowagie.text.pdf.IntHashtable)"><!-- --></A><H3>
mapGotoBookmark</H3>
<PRE>
private static void <B>mapGotoBookmark</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</A>&nbsp;map,
                                    <A HREF="../../../../com/lowagie/text/pdf/PdfObject.html" title="class in com.lowagie.text.pdf">PdfObject</A>&nbsp;dest,
                                    <A HREF="../../../../com/lowagie/text/pdf/IntHashtable.html" title="class in com.lowagie.text.pdf">IntHashtable</A>&nbsp;pages)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="makeBookmarkParam(com.lowagie.text.pdf.PdfArray, com.lowagie.text.pdf.IntHashtable)"><!-- --></A><H3>
makeBookmarkParam</H3>
<PRE>
private static <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>makeBookmarkParam</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfArray.html" title="class in com.lowagie.text.pdf">PdfArray</A>&nbsp;dest,
                                        <A HREF="../../../../com/lowagie/text/pdf/IntHashtable.html" title="class in com.lowagie.text.pdf">IntHashtable</A>&nbsp;pages)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getNumber(com.lowagie.text.pdf.PdfIndirectReference)"><!-- --></A><H3>
getNumber</H3>
<PRE>
private static int <B>getNumber</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfIndirectReference.html" title="class in com.lowagie.text.pdf">PdfIndirectReference</A>&nbsp;indirect)</PRE>
<DL>
<DD>Gets number of indirect. If type of directed indirect is PAGES, it refers PAGE object through KIDS.
 (Contributed by Kazuya Ujihara)
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>indirect</CODE> - 2004-06-13</DL>
</DD>
</DL>
<HR>

<A NAME="getBookmark(com.lowagie.text.pdf.PdfReader)"><!-- --></A><H3>
getBookmark</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A> <B>getBookmark</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfReader.html" title="class in com.lowagie.text.pdf">PdfReader</A>&nbsp;reader)</PRE>
<DL>
<DD>Gets a <CODE>List</CODE> with the bookmarks. It returns <CODE>null</CODE> if
 the document doesn't have any bookmarks.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reader</CODE> - the document
<DT><B>Returns:</B><DD>a <CODE>List</CODE> with the bookmarks or <CODE>null</CODE> if the
 document doesn't have any</DL>
</DD>
</DL>
<HR>

<A NAME="eliminatePages(java.util.List, int[])"><!-- --></A><H3>
eliminatePages</H3>
<PRE>
public static void <B>eliminatePages</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&nbsp;list,
                                  int[]&nbsp;pageRange)</PRE>
<DL>
<DD>Removes the bookmark entries for a number of page ranges. The page ranges
 consists of a number of pairs with the start/end page range. The page numbers
 are inclusive.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>list</CODE> - the bookmarks<DD><CODE>pageRange</CODE> - the page ranges, always in pairs.</DL>
</DD>
</DL>
<HR>

<A NAME="shiftPageNumbers(java.util.List, int, int[])"><!-- --></A><H3>
shiftPageNumbers</H3>
<PRE>
public static void <B>shiftPageNumbers</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&nbsp;list,
                                    int&nbsp;pageShift,
                                    int[]&nbsp;pageRange)</PRE>
<DL>
<DD>For the pages in range add the <CODE>pageShift</CODE> to the page number.
 The page ranges
 consists of a number of pairs with the start/end page range. The page numbers
 are inclusive.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>list</CODE> - the bookmarks<DD><CODE>pageShift</CODE> - the number to add to the pages in range<DD><CODE>pageRange</CODE> - the page ranges, always in pairs. It can be <CODE>null</CODE>
 to include all the pages</DL>
</DD>
</DL>
<HR>

<A NAME="createOutlineAction(com.lowagie.text.pdf.PdfDictionary, java.util.HashMap, com.lowagie.text.pdf.PdfWriter, boolean)"><!-- --></A><H3>
createOutlineAction</H3>
<PRE>
static void <B>createOutlineAction</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfDictionary.html" title="class in com.lowagie.text.pdf">PdfDictionary</A>&nbsp;outline,
                                <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</A>&nbsp;map,
                                <A HREF="../../../../com/lowagie/text/pdf/PdfWriter.html" title="class in com.lowagie.text.pdf">PdfWriter</A>&nbsp;writer,
                                boolean&nbsp;namedAsNames)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="iterateOutlines(com.lowagie.text.pdf.PdfWriter, com.lowagie.text.pdf.PdfIndirectReference, java.util.List, boolean)"><!-- --></A><H3>
iterateOutlines</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] <B>iterateOutlines</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfWriter.html" title="class in com.lowagie.text.pdf">PdfWriter</A>&nbsp;writer,
                                       <A HREF="../../../../com/lowagie/text/pdf/PdfIndirectReference.html" title="class in com.lowagie.text.pdf">PdfIndirectReference</A>&nbsp;parent,
                                       <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&nbsp;kids,
                                       boolean&nbsp;namedAsNames)
                                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><DL>
</DL>
</DD>
<DD><DL>

<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="exportToXMLNode(java.util.List, java.io.Writer, int, boolean)"><!-- --></A><H3>
exportToXMLNode</H3>
<PRE>
public static void <B>exportToXMLNode</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&nbsp;list,
                                   <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A>&nbsp;out,
                                   int&nbsp;indent,
                                   boolean&nbsp;onlyASCII)
                            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>Exports the bookmarks to XML. Only of use if the generation is to be include in
 some other XML document.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>list</CODE> - the bookmarks<DD><CODE>out</CODE> - the export destination. The writer is not closed<DD><CODE>indent</CODE> - the indentation level. Pretty printing significant only<DD><CODE>onlyASCII</CODE> - codes above 127 will always be escaped with &amp;#nn; if <CODE>true</CODE>,
 whatever the encoding
<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> - on error</DL>
</DD>
</DL>
<HR>

<A NAME="exportToXML(java.util.List, java.io.OutputStream, java.lang.String, boolean)"><!-- --></A><H3>
exportToXML</H3>
<PRE>
public static void <B>exportToXML</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&nbsp;list,
                               <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;encoding,
                               boolean&nbsp;onlyASCII)
                        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>Exports the bookmarks to XML. The DTD for this XML is:
 <p>
 <pre>
 &lt;?xml version='1.0' encoding='UTF-8'?&gt;
 &lt;!ELEMENT Title (#PCDATA|Title)*&gt;
 &lt;!ATTLIST Title
    Action CDATA #IMPLIED
    Open CDATA #IMPLIED
    Page CDATA #IMPLIED
    URI CDATA #IMPLIED
    File CDATA #IMPLIED
    Named CDATA #IMPLIED
    NamedN CDATA #IMPLIED
    NewWindow CDATA #IMPLIED
    Style CDATA #IMPLIED
    Color CDATA #IMPLIED
 &gt;
 &lt;!ELEMENT Bookmark (Title)*&gt;
 </pre>
<P>
<DD><DL>