|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.pdfbox.pdmodel.common.PDPageLabelRange
public class PDPageLabelRange
Contains information for a page label range.
PDPageLabels
Field Summary | |
---|---|
static String |
STYLE_DECIMAL
Decimal page numbering style (1, 2, 3, ...). |
static String |
STYLE_LETTERS_LOWER
Letter (lower case) numbering style (a, b, ..., z, aa, bb, ..., zz, aaa, ...). |
static String |
STYLE_LETTERS_UPPER
Letter (upper case) numbering style (A, B, ..., Z, AA, BB, ..., ZZ, AAA, ...). |
static String |
STYLE_ROMAN_LOWER
Roman numbers (lower case) numbering style (i, ii, iii, iv, ...). |
static String |
STYLE_ROMAN_UPPER
Roman numbers (upper case) numbering style (I, II, III, IV, ...). |
Constructor Summary | |
---|---|
PDPageLabelRange()
Creates a new empty page label range object. |
|
PDPageLabelRange(COSDictionary dict)
Creates a new page label range object from the given dictionary. |
Method Summary | |
---|---|
COSDictionary |
getCOSDictionary()
Returns the underlying dictionary. |
COSBase |
getCOSObject()
Convert this standard java object to a COS object. |
String |
getPrefix()
Returns the page label prefix for this page range. |
int |
getStart()
Returns the start value for page numbering in this page range. |
String |
getStyle()
Returns the numbering style for this page range. |
void |
setPrefix(String prefix)
Sets the page label prefix for this page range. |
void |
setStart(int start)
Sets the start value for page numbering in this page range. |
void |
setStyle(String style)
Sets the numbering style for this page range. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String STYLE_DECIMAL
public static final String STYLE_ROMAN_UPPER
public static final String STYLE_ROMAN_LOWER
public static final String STYLE_LETTERS_UPPER
public static final String STYLE_LETTERS_LOWER
Constructor Detail |
---|
public PDPageLabelRange()
public PDPageLabelRange(COSDictionary dict)
dict
- the base dictionary for the new object.Method Detail |
---|
public COSDictionary getCOSDictionary()
public COSBase getCOSObject()
COSObjectable
getCOSObject
in interface COSObjectable
public String getStyle()
public void setStyle(String style)
style
- one of the STYLE_* constants or null
if no page
numbering is desired.public int getStart()
public void setStart(int start)
start
- a positive integer representing the start value.
IllegalArgumentException
- if start
is not a positive integerpublic String getPrefix()
null
if no
prefix has been defined.public void setPrefix(String prefix)
prefix
- the page label prefix for this page range, or null
to
unset the prefix.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |