pdfpagelabels.html

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

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="DECIMAL_ARABIC_NUMERALS"><!-- --></A><H3>
DECIMAL_ARABIC_NUMERALS</H3>
<PRE>
public static final int <B>DECIMAL_ARABIC_NUMERALS</B></PRE>
<DL>
<DD>Logical pages will have the form 1,2,3,...
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.lowagie.text.pdf.PdfPageLabels.DECIMAL_ARABIC_NUMERALS">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="UPPERCASE_ROMAN_NUMERALS"><!-- --></A><H3>
UPPERCASE_ROMAN_NUMERALS</H3>
<PRE>
public static final int <B>UPPERCASE_ROMAN_NUMERALS</B></PRE>
<DL>
<DD>Logical pages will have the form I,II,III,IV,...
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.lowagie.text.pdf.PdfPageLabels.UPPERCASE_ROMAN_NUMERALS">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="LOWERCASE_ROMAN_NUMERALS"><!-- --></A><H3>
LOWERCASE_ROMAN_NUMERALS</H3>
<PRE>
public static final int <B>LOWERCASE_ROMAN_NUMERALS</B></PRE>
<DL>
<DD>Logical pages will have the form i,ii,iii,iv,...
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.lowagie.text.pdf.PdfPageLabels.LOWERCASE_ROMAN_NUMERALS">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="UPPERCASE_LETTERS"><!-- --></A><H3>
UPPERCASE_LETTERS</H3>
<PRE>
public static final int <B>UPPERCASE_LETTERS</B></PRE>
<DL>
<DD>Logical pages will have the form of uppercase letters
 (A to Z for the first 26 pages, AA to ZZ for the next 26, and so on)
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.lowagie.text.pdf.PdfPageLabels.UPPERCASE_LETTERS">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="LOWERCASE_LETTERS"><!-- --></A><H3>
LOWERCASE_LETTERS</H3>
<PRE>
public static final int <B>LOWERCASE_LETTERS</B></PRE>
<DL>
<DD>Logical pages will have the form of uppercase letters
 (a to z for the first 26 pages, aa to zz for the next 26, and so on)
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.lowagie.text.pdf.PdfPageLabels.LOWERCASE_LETTERS">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="EMPTY"><!-- --></A><H3>
EMPTY</H3>
<PRE>
public static final int <B>EMPTY</B></PRE>
<DL>
<DD>No logical page numbers are generated but fixed text may
 still exist
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.lowagie.text.pdf.PdfPageLabels.EMPTY">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="numberingStyle"><!-- --></A><H3>
numberingStyle</H3>
<PRE>
static <A HREF="../../../../com/lowagie/text/pdf/PdfName.html" title="class in com.lowagie.text.pdf">PdfName</A>[] <B>numberingStyle</B></PRE>
<DL>
<DD>Dictionary values to set the logical page styles
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="map"><!-- --></A><H3>
map</H3>
<PRE>
private <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> <B>map</B></PRE>
<DL>
<DD>The sequence of logical pages. Will contain at least a value for page 1
<P>
<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="PdfPageLabels()"><!-- --></A><H3>
PdfPageLabels</H3>
<PRE>
public <B>PdfPageLabels</B>()</PRE>
<DL>
<DD>Creates a new PdfPageLabel with a default logical page 1
<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="addPageLabel(int, int, java.lang.String, int)"><!-- --></A><H3>
addPageLabel</H3>
<PRE>
public void <B>addPageLabel</B>(int&nbsp;page,
                         int&nbsp;numberStyle,
                         <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;text,
                         int&nbsp;firstPage)</PRE>
<DL>
<DD>Adds or replaces a page label.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>page</CODE> - the real page to start the numbering. First page is 1<DD><CODE>numberStyle</CODE> - the numbering style such as LOWERCASE_ROMAN_NUMERALS<DD><CODE>text</CODE> - the text to prefix the number. Can be <CODE>null</CODE> or empty<DD><CODE>firstPage</CODE> - the first logical page number</DL>
</DD>
</DL>
<HR>

<A NAME="addPageLabel(int, int, java.lang.String)"><!-- --></A><H3>
addPageLabel</H3>
<PRE>
public void <B>addPageLabel</B>(int&nbsp;page,
                         int&nbsp;numberStyle,
                         <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;text)</PRE>
<DL>
<DD>Adds or replaces a page label. The first logical page has the default
 of 1.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>page</CODE> - the real page to start the numbering. First page is 1<DD><CODE>numberStyle</CODE> - the numbering style such as LOWERCASE_ROMAN_NUMERALS<DD><CODE>text</CODE> - the text to prefix the number. Can be <CODE>null</CODE> or empty</DL>
</DD>
</DL>
<HR>

<A NAME="addPageLabel(int, int)"><!-- --></A><H3>
addPageLabel</H3>
<PRE>
public void <B>addPageLabel</B>(int&nbsp;page,
                         int&nbsp;numberStyle)</PRE>
<DL>
<DD>Adds or replaces a page label. There is no text prefix and the first
 logical page has the default of 1.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>page</CODE> - the real page to start the numbering. First page is 1<DD><CODE>numberStyle</CODE> - the numbering style such as LOWERCASE_ROMAN_NUMERALS</DL>
</DD>
</DL>
<HR>

<A NAME="addPageLabel(com.lowagie.text.pdf.PdfPageLabels.PdfPageLabelFormat)"><!-- --></A><H3>
addPageLabel</H3>
<PRE>
public void <B>addPageLabel</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfPageLabels.PdfPageLabelFormat.html" title="class in com.lowagie.text.pdf">PdfPageLabels.PdfPageLabelFormat</A>&nbsp;format)</PRE>
<DL>
<DD>Adds or replaces a page label.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="removePageLabel(int)"><!-- --></A><H3>
removePageLabel</H3>
<PRE>
public void <B>removePageLabel</B>(int&nbsp;page)</PRE>
<DL>
<DD>Removes a page label. The first page label can not be removed, only changed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>page</CODE> - the real page to remove</DL>
</DD>
</DL>
<HR>

<A NAME="getDictionary(com.lowagie.text.pdf.PdfWriter)"><!-- --></A><H3>
getDictionary</H3>
<PRE>
<A HREF="../../../../com/lowagie/text/pdf/PdfDictionary.html" title="class in com.lowagie.text.pdf">PdfDictionary</A> <B>getDictionary</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfWriter.html" title="class in com.lowagie.text.pdf">PdfWriter</A>&nbsp;writer)</PRE>
<DL>
<DD>Gets the page label dictionary to insert into the document.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the page label dictionary</DL>
</DD>
</DL>
<HR>

<A NAME="getPageLabels(com.lowagie.text.pdf.PdfReader)"><!-- --></A><H3>
getPageLabels</H3>
<PRE>
public 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>getPageLabels</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfReader.html" title="class in com.lowagie.text.pdf">PdfReader</A>&nbsp;reader)</PRE>
<DL>
<DD>Retrieves the page labels from a PDF as an array of String objects.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reader</CODE> - a PdfReader object that has the page labels you want to retrieve
<DT><B>Returns:</B><DD>a String array or <code>null</code> if no page labels are present</DL>
</DD>
</DL>
<HR>

<A NAME="getPageLabelFormats(com.lowagie.text.pdf.PdfReader)"><!-- --></A><H3>
getPageLabelFormats</H3>
<PRE>
public static <A HREF="../../../../com/lowagie/text/pdf/PdfPageLabels.PdfPageLabelFormat.html" title="class in com.lowagie.text.pdf">PdfPageLabels.PdfPageLabelFormat</A>[] <B>getPageLabelFormats</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfReader.html" title="class in com.lowagie.text.pdf">PdfReader</A>&nbsp;reader)</PRE>
<DL>
<DD>Retrieves the page labels from a PDF as an array of <A HREF="../../../../com/lowagie/text/pdf/PdfPageLabels.PdfPageLabelFormat.html" title="class in com.lowagie.text.pdf"><CODE>PdfPageLabels.PdfPageLabelFormat</CODE></A> objects.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reader</CODE> - a PdfReader object that has the page labels you want to retrieve
<DT><B>Returns:</B><DD>a PdfPageLabelEntry array, containing an entry for each format change
 or <code>null</code> if no page labels are present</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/pdf/PdfPageEventHelper.html" title="class in com.lowagie.text.pdf"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/lowagie/text/pdf/PdfPageLabels.PdfPageLabelFormat.html" title="class in com.lowagie.text.pdf"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?com/lowagie/text/pdf/PdfPageLabels.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PdfPageLabels.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;<A HREF="#nested_class_summary">NESTED</A>&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>