Class PdfPageLabels

java.lang.Object
com.aowagie.text.pdf.PdfPageLabels

class PdfPageLabels extends Object
Page labels are used to identify each page visually on the screen or in print.
  • Field Details

    • DECIMAL_ARABIC_NUMERALS

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

      private static PdfName[] numberingStyle
      Dictionary values to set the logical page styles
    • map

      private final HashMap map
      The sequence of logical pages. Will contain at least a value for page 1
  • Constructor Details

    • PdfPageLabels

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

    • addPageLabel

      private 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
    • getDictionary

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