Package com.lowagie.text.pdf

Class PdfPageLabels

java.lang.Object
com.lowagie.text.pdf.PdfPageLabels
public class PdfPageLabels extends Object
Page labels are used to identify each page visually on the screen or in print.
Author:
Paulo Soares (psoares@consiste.pt)

  • Field Details

    • DECIMAL_ARABIC_NUMERALS

      public static final int DECIMAL_ARABIC_NUMERALS
      Logical pages will have the form 1,2,3,...
      See Also:

    • UPPERCASE_ROMAN_NUMERALS

      public static final int UPPERCASE_ROMAN_NUMERALS
      Logical pages will have the form I,II,III,IV,...
      See Also:

    • LOWERCASE_ROMAN_NUMERALS

      public static final int LOWERCASE_ROMAN_NUMERALS
      Logical pages will have the form i,ii,iii,iv,...
      See Also:

    • UPPERCASE_LETTERS

      public static final int UPPERCASE_LETTERS
      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)
      See Also:

    • LOWERCASE_LETTERS

      public static final int LOWERCASE_LETTERS
      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)
      See Also:

    • EMPTY

      public static final int EMPTY
      No logical page numbers are generated but fixed text may still exist
      See Also:

  • Constructor Details

    • PdfPageLabels

      public PdfPageLabels()
      Creates a new PdfPageLabel with a default logical page 1

  • Method Details

    • addPageLabel

      public void addPageLabel(int page, int numberStyle, String text, int firstPage)
      Adds or replaces a page label.
      Parameters:
      page - the real page to start the numbering. First page is 1
      numberStyle - the numbering style such as LOWERCASE_ROMAN_NUMERALS
      text - the text to prefix the number. Can be null or empty
      firstPage - the first logical page number

    • addPageLabel

      public void addPageLabel(int page, int numberStyle, String text)
      Adds or replaces a page label. The first logical page has the default of 1.
      Parameters:
      page - the real page to start the numbering. First page is 1
      numberStyle - the numbering style such as LOWERCASE_ROMAN_NUMERALS
      text - the text to prefix the number. Can be null or empty

    • addPageLabel

      public void addPageLabel(int page, int numberStyle)
      Adds or replaces a page label. There is no text prefix and the first logical page has the default of 1.
      Parameters:
      page - the real page to start the numbering. First page is 1
      numberStyle - the numbering style such as LOWERCASE_ROMAN_NUMERALS

    • addPageLabel

      public void addPageLabel(PdfPageLabels.PdfPageLabelFormat format)
      Adds or replaces a page label.

    • removePageLabel

      public void removePageLabel(int page)
      Removes a page label. The first page label can not be removed, only changed.
      Parameters:
      page - the real page to remove

    • getDictionary

      protected PdfDictionary getDictionary(PdfWriter writer)
      Gets the page label dictionary to insert into the document.
      Returns:
      the page label dictionary

    • getPageLabels

      public static String[] getPageLabels(PdfReader reader)
      Retrieves the page labels from a PDF as an array of String objects.
      Parameters:
      reader - a PdfReader object that has the page labels you want to retrieve
      Returns:
      a String array or null if no page labels are present

    • getPageLabelFormats

      public static PdfPageLabels.PdfPageLabelFormat[] getPageLabelFormats(PdfReader reader)
      Retrieves the page labels from a PDF as an array of PdfPageLabels.PdfPageLabelFormat objects.
      Parameters:
      reader - a PdfReader object that has the page labels you want to retrieve
      Returns:
      a PdfPageLabelEntry array, containing an entry for each format change or null if no page labels are present