Class PdfPageLabels
- java.lang.Object
-
- com.gitlab.pdftk_java.com.lowagie.text.pdf.PdfPageLabels
-
- All Implemented Interfaces:
java.util.Comparator
public class PdfPageLabels extends java.lang.Object implements java.util.Comparator
Page labels are used to identify each page visually on the screen or in print.
-
-
Field Summary
Fields Modifier and Type Field Description static int
DECIMAL_ARABIC_NUMERALS
Logical pages will have the form 1,2,3,...static int
EMPTY
No logical page numbers are generated but fixed text may still existstatic 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)static int
LOWERCASE_ROMAN_NUMERALS
Logical pages will have the form i,ii,iii,iv,...(package private) java.util.TreeMap
map
The sequence of logical pages.(package private) static PdfName[]
numberingStyle
Dictionary values to set the logical page stylesstatic 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)static int
UPPERCASE_ROMAN_NUMERALS
Logical pages will have the form I,II,III,IV,...
-
Constructor Summary
Constructors Constructor Description PdfPageLabels()
Creates a new PdfPageLabel with a default logical page 1
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addPageLabel(int page, int numberStyle)
Adds or replaces a page label.void
addPageLabel(int page, int numberStyle, java.lang.String text)
Adds or replaces a page label.void
addPageLabel(int page, int numberStyle, java.lang.String text, int firstPage)
Adds or replaces a page label.int
compare(java.lang.Object obj, java.lang.Object obj1)
Compares twoInteger
.boolean
equals(java.lang.Object obj)
Not usedPdfDictionary
getDictionary()
Gets the page label dictionary to insert into the document.void
removePageLabel(int page)
Removes a page label.
-
-
-
Field Detail
-
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
java.util.TreeMap map
The sequence of logical pages. Will contain at least a value for page 1
-
-
Method Detail
-
compare
public int compare(java.lang.Object obj, java.lang.Object obj1)
Compares twoInteger
.- Specified by:
compare
in interfacejava.util.Comparator
- Parameters:
obj
- the firstInteger
obj1
- the secondInteger
- 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(java.lang.Object obj)
Not used- Specified by:
equals
in interfacejava.util.Comparator
- Overrides:
equals
in classjava.lang.Object
- Parameters:
obj
- not used- Returns:
- always
true
-
addPageLabel
public void addPageLabel(int page, int numberStyle, java.lang.String text, int firstPage)
Adds or replaces a page label.- Parameters:
page
- the real page to start the numbering. First page is 1numberStyle
- the numbering style such as LOWERCASE_ROMAN_NUMERALStext
- the text to prefix the number. Can benull
or emptyfirstPage
- the first logical page number
-
addPageLabel
public void addPageLabel(int page, int numberStyle, java.lang.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 1numberStyle
- the numbering style such as LOWERCASE_ROMAN_NUMERALStext
- the text to prefix the number. Can benull
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 1numberStyle
- 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
-
-