|
||||||||||
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.
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,... |
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. |
int |
compare(Object obj,
Object obj1)
Compares two Integer . |
boolean |
equals(Object obj)
Not used |
void |
removePageLabel(int page)
Removes a page label. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static int DECIMAL_ARABIC_NUMERALS
public static int UPPERCASE_ROMAN_NUMERALS
public static int LOWERCASE_ROMAN_NUMERALS
public static int UPPERCASE_LETTERS
public static int LOWERCASE_LETTERS
public static int EMPTY
Constructor Detail |
---|
public PdfPageLabels()
Method Detail |
---|
public int compare(Object obj, Object obj1)
Integer
.
compare
in interface Comparator
obj
- the first Integer
obj1
- the second Integer
public boolean equals(Object obj)
equals
in interface Comparator
equals
in class Object
obj
- not used
true
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 numberpublic 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 emptypublic 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 removePageLabel(int page)
page
- the real page to remove
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |