Module org.sejda.sambox

Package org.sejda.sambox.pdmodel.common

Class PDPageLabelRange

java.lang.Object

org.sejda.sambox.pdmodel.common.PDPageLabelRange

All Implemented Interfaces:

COSObjectable

public class PDPageLabelRange
extends Object
implements COSObjectable

Contains information for a page label range.

Author:

Igor Podolskiy

See Also:

• PDPageLabels

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STYLE_DECIMAL	Decimal page numbering style (1, 2, 3, ...).
static final String	STYLE_LETTERS_LOWER	Letter (lower case) numbering style (a, b, ..., z, aa, bb, ..., zz, aaa, ...).
static final String	STYLE_LETTERS_UPPER	Letter (upper case) numbering style (A, B, ..., Z, AA, BB, ..., ZZ, AAA, ...).
static final String	STYLE_ROMAN_LOWER	Roman numbers (lower case) numbering style (i, ii, iii, iv, ...).
static final String	STYLE_ROMAN_UPPER	Roman numbers (upper case) numbering style (I, II, III, IV, ...).

Constructor Summary

Constructors

Constructor	Description
PDPageLabelRange()	Creates a new empty page label range object.
PDPageLabelRange(String style, String prefix, Integer start)
PDPageLabelRange(COSDictionary dict)	Creates a new page label range object from the given dictionary.

Method Summary

Modifier and Type	Method	Description
COSDictionary	getCOSObject()	Returns the underlying dictionary.
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.
boolean	hasStart()
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 Details

STYLE_DECIMAL

public static final String STYLE_DECIMAL

Decimal page numbering style (1, 2, 3, ...).

See Also:

• Constant Field Values

STYLE_ROMAN_UPPER

public static final String STYLE_ROMAN_UPPER

Roman numbers (upper case) numbering style (I, II, III, IV, ...).

See Also:

• Constant Field Values

STYLE_ROMAN_LOWER

public static final String STYLE_ROMAN_LOWER

Roman numbers (lower case) numbering style (i, ii, iii, iv, ...).

See Also:

• Constant Field Values

STYLE_LETTERS_UPPER

public static final String STYLE_LETTERS_UPPER

Letter (upper case) numbering style (A, B, ..., Z, AA, BB, ..., ZZ, AAA, ...).

See Also:

• Constant Field Values

STYLE_LETTERS_LOWER

public static final String STYLE_LETTERS_LOWER

Letter (lower case) numbering style (a, b, ..., z, aa, bb, ..., zz, aaa, ...).

See Also:

• Constant Field Values

Constructor Details

PDPageLabelRange

public PDPageLabelRange()

Creates a new empty page label range object.

PDPageLabelRange

public PDPageLabelRange(COSDictionary dict)

Creates a new page label range object from the given dictionary.

Parameters:

dict - the base dictionary for the new object.

PDPageLabelRange

public PDPageLabelRange(String style,
 String prefix,
 Integer start)

Method Details

getCOSObject

public COSDictionary getCOSObject()

Returns the underlying dictionary.

Specified by:

getCOSObject in interface COSObjectable

Returns:

the underlying dictionary.

getStyle

public String getStyle()

Returns the numbering style for this page range.

Returns:

one of the STYLE_* constants

setStyle

public void setStyle(String style)

Sets the numbering style for this page range.

Parameters:

style - one of the STYLE_* constants or null 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.

hasStart

public boolean hasStart()

Returns:

true if the start value for page numbering is defined, false otherwise.

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 - if start is not a positive integer

getPrefix

public String 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

public void setPrefix(String prefix)

Sets the page label prefix for this page range.

Parameters:

prefix - the page label prefix for this page range, or null to unset the prefix.