org.sejda.impl.sambox.component

Class OutlineUtils

java.lang.Object

org.sejda.impl.sambox.component.OutlineUtils

public final class OutlineUtils
extends Object

Utility methods related to outline handling in SAMBox

Author:

Andrea Vacondio

Method Summary

Modifier and Type	Method and Description
static org.sejda.sambox.pdmodel.interactive.documentnavigation.destination.PDPageDestination	clonePageDestination(org.sejda.sambox.pdmodel.interactive.documentnavigation.destination.PDPageDestination dest, org.sejda.sambox.pdmodel.PDPage destPage) Creates a clone of the given page destination pointing to the given new page.
static void	copyOutlineDictionary(org.sejda.sambox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem from, org.sejda.sambox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem to) Copies the dictionary from the given PDOutlineItem to the destination one
static List<OutlineItem>	getFlatOutline(org.sejda.sambox.pdmodel.PDDocument document)
static Set<Integer>	getOutlineLevelsWithPageDestination(org.sejda.sambox.pdmodel.PDDocument document)
static Optional<org.sejda.sambox.pdmodel.interactive.documentnavigation.destination.PDPageDestination>	toPageDestination(org.sejda.sambox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem current, org.sejda.sambox.pdmodel.PDDocumentCatalog catalog)

Methods inherited from class java.lang.Object

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

Method Detail

getOutlineLevelsWithPageDestination

public static Set<Integer> getOutlineLevelsWithPageDestination(org.sejda.sambox.pdmodel.PDDocument document)

Parameters:

document -

Returns:

a set containing the the outline levels having at least one page destination

toPageDestination

public static Optional<org.sejda.sambox.pdmodel.interactive.documentnavigation.destination.PDPageDestination> toPageDestination(org.sejda.sambox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem current,
                                                                                                                                org.sejda.sambox.pdmodel.PDDocumentCatalog catalog)

Parameters:

current - the outline item

catalog - the catalog to look for in case of PDNamedDestination

Returns:

the PDPageDestination for the given PDOutlineItem or an empty Optional if the destination is not a page. In case the outline item has a named destination, it is resolved against the given names tree.

clonePageDestination

public static org.sejda.sambox.pdmodel.interactive.documentnavigation.destination.PDPageDestination clonePageDestination(org.sejda.sambox.pdmodel.interactive.documentnavigation.destination.PDPageDestination dest,
                                                                                                                         org.sejda.sambox.pdmodel.PDPage destPage)

Creates a clone of the given page destination pointing to the given new page. If an error occur it falls back to a PDPageXYZDestination.

Parameters:

dest -

destPage - the new pointed page

Returns:

copyOutlineDictionary

public static void copyOutlineDictionary(org.sejda.sambox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem from,
                                         org.sejda.sambox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem to)

Copies the dictionary from the given PDOutlineItem to the destination one

Parameters:

from -

to -

getFlatOutline

public static List<OutlineItem> getFlatOutline(org.sejda.sambox.pdmodel.PDDocument document)

Parameters:

document -

Returns:

A sorted flat representation of the document outline