COSObjectable
public class PDPageLabelRange extends java.lang.Object implements COSObjectable
PDPageLabels
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
STYLE_DECIMAL |
Decimal page numbering style (1, 2, 3, ...).
|
static java.lang.String |
STYLE_LETTERS_LOWER |
Letter (lower case) numbering style (a, b, ..., z, aa, bb, ..., zz, aaa,
...).
|
static java.lang.String |
STYLE_LETTERS_UPPER |
Letter (upper case) numbering style (A, B, ..., Z, AA, BB, ..., ZZ, AAA,
...).
|
static java.lang.String |
STYLE_ROMAN_LOWER |
Roman numbers (lower case) numbering style (i, ii, iii, iv, ...).
|
static java.lang.String |
STYLE_ROMAN_UPPER |
Roman numbers (upper case) numbering style (I, II, III, IV, ...).
|
Constructor | Description |
---|---|
PDPageLabelRange() |
Creates a new empty page label range object.
|
PDPageLabelRange(COSDictionary dict) |
Creates a new page label range object from the given dictionary.
|
Modifier and Type | Method | Description |
---|---|---|
COSDictionary |
getCOSDictionary() |
Returns the underlying dictionary.
|
COSBase |
getCOSObject() |
Convert this standard java object to a COS object.
|
java.lang.String |
getPrefix() |
Returns the page label prefix for this page range.
|
int |
getStart() |
Returns the start value for page numbering in this page range.
|
java.lang.String |
getStyle() |
Returns the numbering style for this page range.
|
void |
setPrefix(java.lang.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(java.lang.String style) |
Sets the numbering style for this page range.
|
public static final java.lang.String STYLE_DECIMAL
public static final java.lang.String STYLE_ROMAN_UPPER
public static final java.lang.String STYLE_ROMAN_LOWER
public static final java.lang.String STYLE_LETTERS_UPPER
public static final java.lang.String STYLE_LETTERS_LOWER
public PDPageLabelRange()
public PDPageLabelRange(COSDictionary dict)
dict
- the base dictionary for the new object.public COSDictionary getCOSDictionary()
public COSBase getCOSObject()
COSObjectable
getCOSObject
in interface COSObjectable
public java.lang.String getStyle()
public void setStyle(java.lang.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.java.lang.IllegalArgumentException
- if start
is not a positive integerpublic java.lang.String getPrefix()
null
if no
prefix has been defined.public void setPrefix(java.lang.String prefix)
prefix
- the page label prefix for this page range, or null
to
unset the prefix.