Package org.apache.pdfbox.pdmodel.common
Class PDPageLabelRange
java.lang.Object
org.apache.pdfbox.pdmodel.common.PDPageLabelRange
- All Implemented Interfaces:
COSObjectable
Contains information for a page label range.
- Author:
- Igor Podolskiy
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Decimal page numbering style (1, 2, 3, ...).static final String
Letter (lower case) numbering style (a, b, ..., z, aa, bb, ..., zz, aaa, ...).static final String
Letter (upper case) numbering style (A, B, ..., Z, AA, BB, ..., ZZ, AAA, ...).static final String
Roman numbers (lower case) numbering style (i, ii, iii, iv, ...).static final String
Roman numbers (upper case) numbering style (I, II, III, IV, ...). -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new empty page label range object.Creates a new page label range object from the given dictionary. -
Method Summary
Modifier and TypeMethodDescriptionReturns the underlying dictionary.Returns the page label prefix for this page range.int
getStart()
Returns the start value for page numbering in this page range.getStyle()
Returns the numbering style for this page range.void
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
Sets the numbering style for this page range.
-
Field Details
-
STYLE_DECIMAL
Decimal page numbering style (1, 2, 3, ...).- See Also:
-
STYLE_ROMAN_UPPER
Roman numbers (upper case) numbering style (I, II, III, IV, ...).- See Also:
-
STYLE_ROMAN_LOWER
Roman numbers (lower case) numbering style (i, ii, iii, iv, ...).- See Also:
-
STYLE_LETTERS_UPPER
Letter (upper case) numbering style (A, B, ..., Z, AA, BB, ..., ZZ, AAA, ...).- See Also:
-
STYLE_LETTERS_LOWER
Letter (lower case) numbering style (a, b, ..., z, aa, bb, ..., zz, aaa, ...).- See Also:
-
-
Constructor Details
-
PDPageLabelRange
public PDPageLabelRange()Creates a new empty page label range object. -
PDPageLabelRange
Creates a new page label range object from the given dictionary.- Parameters:
dict
- the base dictionary for the new object.
-
-
Method Details
-
getCOSObject
Returns the underlying dictionary.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- the underlying dictionary.
-
getStyle
Returns the numbering style for this page range.- Returns:
- one of the STYLE_* constants
-
setStyle
Sets the numbering style for this page range.- Parameters:
style
- one of the STYLE_* constants ornull
if no page numbering is desired.
-
getStart
public int getStart()Returns the start value for page numbering in this page range.- Returns:
- a positive integer the start value for numbering.
-
setStart
public void setStart(int start) Sets the start value for page numbering in this page range.- Parameters:
start
- a positive integer representing the start value.- Throws:
IllegalArgumentException
- ifstart
is not a positive integer
-
getPrefix
Returns the page label prefix for this page range.- Returns:
- the page label prefix for this page range, or
null
if no prefix has been defined.
-
setPrefix
Sets the page label prefix for this page range.- Parameters:
prefix
- the page label prefix for this page range, ornull
to unset the prefix.
-