|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.lowagie.text.pdf.PdfPageLabels
public class PdfPageLabels
Page labels are used to identify each page visually on the screen or in print.
| Nested Class Summary | |
|---|---|
static class |
PdfPageLabels.PdfPageLabelFormat
|
| Field Summary | |
|---|---|
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 exist |
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) |
static int |
LOWERCASE_ROMAN_NUMERALS
Logical pages will have the form i,ii,iii,iv,... |
private HashMap |
map
The sequence of logical pages. |
(package private) static PdfName[] |
numberingStyle
Dictionary values to set the logical page styles |
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) |
static int |
UPPERCASE_ROMAN_NUMERALS
Logical pages will have the form I,II,III,IV,... |
| Constructor Summary | |
|---|---|
PdfPageLabels()
Creates a new PdfPageLabel with a default logical page 1 |
|
| Method Summary | |
|---|---|
void |
addPageLabel(int page,
int numberStyle)
Adds or replaces a page label. |
void |
addPageLabel(int page,
int numberStyle,
String text)
Adds or replaces a page label. |
void |
addPageLabel(int page,
int numberStyle,
String text,
int firstPage)
Adds or replaces a page label. |
void |
addPageLabel(PdfPageLabels.PdfPageLabelFormat format)
Adds or replaces a page label. |
(package private) PdfDictionary |
getDictionary(PdfWriter writer)
Gets the page label dictionary to insert into the document. |
static PdfPageLabels.PdfPageLabelFormat[] |
getPageLabelFormats(PdfReader reader)
Retrieves the page labels from a PDF as an array of PdfPageLabels.PdfPageLabelFormat objects. |
static String[] |
getPageLabels(PdfReader reader)
Retrieves the page labels from a PDF as an array of String objects. |
void |
removePageLabel(int page)
Removes a page label. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final int DECIMAL_ARABIC_NUMERALS
public static final int UPPERCASE_ROMAN_NUMERALS
public static final int LOWERCASE_ROMAN_NUMERALS
public static final int UPPERCASE_LETTERS
public static final int LOWERCASE_LETTERS
public static final int EMPTY
static PdfName[] numberingStyle
private HashMap map
| Constructor Detail |
|---|
public PdfPageLabels()
| Method Detail |
|---|
public void addPageLabel(int page,
int numberStyle,
String text,
int firstPage)
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 be null or emptyfirstPage - the first logical page number
public void addPageLabel(int page,
int numberStyle,
String text)
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 be null or empty
public void addPageLabel(int page,
int numberStyle)
page - the real page to start the numbering. First page is 1numberStyle - the numbering style such as LOWERCASE_ROMAN_NUMERALSpublic void addPageLabel(PdfPageLabels.PdfPageLabelFormat format)
public void removePageLabel(int page)
page - the real page to removePdfDictionary getDictionary(PdfWriter writer)
public static String[] getPageLabels(PdfReader reader)
reader - a PdfReader object that has the page labels you want to retrieve
null if no page labels are presentpublic static PdfPageLabels.PdfPageLabelFormat[] getPageLabelFormats(PdfReader reader)
PdfPageLabels.PdfPageLabelFormat objects.
reader - a PdfReader object that has the page labels you want to retrieve
null if no page labels are present
|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||