Class PdfPageLabels

java.lang.Object
com.gitlab.pdftk_java.com.lowagie.text.pdf.PdfPageLabels
All Implemented Interfaces:
Comparator
public class PdfPageLabels extends Object implements Comparator
Page labels are used to identify each page visually on the screen or in print.

  • Field Details

    • DECIMAL_ARABIC_NUMERALS

      public static int DECIMAL_ARABIC_NUMERALS
      Logical pages will have the form 1,2,3,...

    • UPPERCASE_ROMAN_NUMERALS

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

    • LOWERCASE_ROMAN_NUMERALS

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

    • UPPERCASE_LETTERS

      public static 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)

    • LOWERCASE_LETTERS

      public static 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)

    • EMPTY

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

    • numberingStyle

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

    • map

      TreeMap 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

    • compare

      public int compare(Object obj, Object obj1)
      Compares two Integer.
      Specified by:
      compare in interface Comparator
      Parameters:
      obj - the first Integer
      obj1 - the second Integer
      Returns:
      a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second

    • equals

      public boolean equals(Object obj)
      Not used
      Specified by:
      equals in interface Comparator
      Overrides:
      equals in class Object
      Parameters:
      obj - not used
      Returns:
      always true

    • 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

    • 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

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