Module org.sejda.sambox

Package org.sejda.sambox.pdmodel.common

Class PDPageLabels

java.lang.Object

org.sejda.sambox.pdmodel.common.PDPageLabels

All Implemented Interfaces:

COSObjectable

public class PDPageLabels
extends Object
implements COSObjectable

Represents the page label dictionary of a document.

Author:

Igor Podolskiy

Constructor Summary

Constructors

Constructor	Description
PDPageLabels()	Creates an empty page label dictionary for the given document.
PDPageLabels(COSDictionary dict)	Creates an page label dictionary for a document using the information in the given COS dictionary.

Method Summary

Modifier and Type	Method	Description
COSBase	getCOSObject()
Map<Integer,PDPageLabelRange>	getLabels()
PDPageLabelRange	getPageLabelRange(int startPage)	Returns the page label range starting at the given page, or null if no such range is defined.
int	getPageRangeCount()	Returns the number of page label ranges.
void	setLabelItem(int startPage, PDPageLabelRange item)	Sets the page label range beginning at the specified start page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PDPageLabels

public PDPageLabels()

Creates an empty page label dictionary for the given document.

Note that the page label dictionary won't be automatically added to the document; you will still need to do it manually (see PDDocumentCatalog.setPageLabels(PDPageLabels).

See Also:

• PDDocumentCatalog.setPageLabels(PDPageLabels)

PDPageLabels

public PDPageLabels(COSDictionary dict)
             throws IOException

Creates an page label dictionary for a document using the information in the given COS dictionary.

Note that the page label dictionary won't be automatically added to the document; you will still need to do it manually (see PDDocumentCatalog.setPageLabels(PDPageLabels).

Parameters:

dict - an existing page label dictionary

Throws:

IOException - If something goes wrong during the number tree conversion.

See Also:

• PDDocumentCatalog.setPageLabels(PDPageLabels)

Method Details

getPageRangeCount

public int getPageRangeCount()

Returns the number of page label ranges.

This will be always >= 1, as the required default entry for the page range starting at the first page is added automatically by this implementation (see PDF32000-1:2008, p. 375).

Returns:

the number of page label ranges.

getPageLabelRange

public PDPageLabelRange getPageLabelRange(int startPage)

Returns the page label range starting at the given page, or null if no such range is defined.

Parameters:

startPage - the 0-based page index representing the start page of the page range the item is defined for.

Returns:

the page label range or null if no label range is defined for the given start page.

setLabelItem

public void setLabelItem(int startPage,
 PDPageLabelRange item)

Sets the page label range beginning at the specified start page.

Parameters:

startPage - the 0-based index of the page representing the start of the page label range.

item - the page label item to set.

Throws:

IllegalArgumentException - if the startPage parameter is < 0.

getLabels

public Map<Integer,PDPageLabelRange> getLabels()

getCOSObject

public COSBase getCOSObject()

Specified by:

getCOSObject in interface COSObjectable

Returns:

The COSBase that matches this Java object.