public PDPageLabels(PDDocument document) 
{
        labels = new TreeMap< Integer, PDPageLabelRange >();
        this.doc = document;
        PDPageLabelRange defaultRange = new PDPageLabelRange();
        defaultRange.setStyle(PDPageLabelRange.STYLE_DECIMAL);
        labels.put(0, defaultRange);
}

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) .

Parameters:

document - The document the page label dictionary is created for.

Also see:

PDDocumentCatalog#setPageLabels(PDPageLabels)

 public PDPageLabels(PDDocument document,
    COSDictionary dict) throws IOException 
{
        this(document);
        if (dict == null)
        {
            return;
        }
        PDNumberTreeNode root = new PDNumberTreeNode(dict, COSDictionary.class);
        Map< Integer, COSDictionary > numbers = root.getNumbers();
        for (Entry< Integer, COSDictionary > i : numbers.entrySet())
        {
            labels.put(i.getKey(), new PDPageLabelRange(i.getValue()));
        }
}

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:

document - The document the page label dictionary is created for.

dict - an existing page label dictionary

Throws:

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

Also see:

PDDocumentCatalog#setPageLabels(PDPageLabels)

 public COSBase getCOSObject() 
{
        COSDictionary dict = new COSDictionary();
        COSArray arr = new COSArray();
        for (Entry< Integer, PDPageLabelRange > i : labels.entrySet())
        {
            arr.add(COSInteger.get(i.getKey()));
            arr.add(i.getValue());
        }
        dict.setItem("Nums", arr);
        return dict;
}

 public String[] getLabelsByPageIndices() 
{
        final String[] map = new String[doc.getNumberOfPages()];
        computeLabels(new LabelHandler()
        {
            public void newLabel(int pageIndex, String label)
            {
                map[pageIndex] = label;
            }
        });
        return map;
}

Returns a mapping with 0-based page indices as keys and corresponding page labels as values as an array. The array will have exactly as much entries as the document has pages.

 public Map<String, Integer> getPageIndicesByLabels() 
{
        final Map< String, Integer > labelMap = 
            new HashMap< String, Integer >(doc.getNumberOfPages());
        computeLabels(new LabelHandler()
        {
            public void newLabel(int pageIndex, String label)
            {
                labelMap.put(label, pageIndex);
            }
        });
        return labelMap;
}

Returns a mapping with computed page labels as keys and corresponding 0-based page indices as values. The returned map will contain at most as much entries as the document has pages.

NOTE: If the document contains duplicate page labels, the returned map will contain less entries than the document has pages. The page index returned in this case is the highest index among all pages sharing the same label.

 public PDPageLabelRange getPageLabelRange(int startPage) 
{
        return labels.get(startPage);
}

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

 public int getPageRangeCount() 
{
        return labels.size();
}

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).

 public  void setLabelItem(int startPage,
    PDPageLabelRange item) 
{
        labels.put(startPage, item);
}

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