Package com.aowagie.text.pdf
Class PdfPageLabels
java.lang.Object
com.aowagie.text.pdf.PdfPageLabels
Page labels are used to identify each
page visually on the screen or in print.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate void
addPageLabel
(int page, int numberStyle, String text, int firstPage) Adds or replaces a page label.(package private) PdfDictionary
getDictionary
(PdfWriter writer) Gets the page label dictionary to insert into the document.
-
Field Details
-
DECIMAL_ARABIC_NUMERALS
private static final int DECIMAL_ARABIC_NUMERALSLogical pages will have the form 1,2,3,...- See Also:
-
numberingStyle
Dictionary values to set the logical page styles -
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
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
-
getDictionary
Gets the page label dictionary to insert into the document.- Returns:
- the page label dictionary
-