org.sejda.impl.sambox.component

Class TableOfContentsCreator

java.lang.Object

org.sejda.impl.sambox.component.TableOfContentsCreator

public class TableOfContentsCreator
extends Object

Component creating a table of content

Author:

Andrea Vacondio

Constructor Summary

Constructors

Constructor and Description
TableOfContentsCreator(MergeParameters params, org.sejda.sambox.pdmodel.PDDocument document)

Method Summary

Modifier and Type	Method and Description
void	addToC() Generates a ToC and prepend it to the given document
void	addToC(int beforePageNumber) Generates a ToC and inserts it in the doc at before the given page number
void	appendItem(String text, long pageNumber, org.sejda.sambox.pdmodel.PDPage page) Adds to the ToC the given text with the given annotation associated
float	getFontSize()
boolean	hasToc()
void	pageSizeIfNotSet(org.sejda.sambox.pdmodel.common.PDRectangle pageSize)
boolean	shouldGenerateToC()
long	tocNumberOfPages()

Methods inherited from class java.lang.Object

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

Constructor Detail

TableOfContentsCreator

public TableOfContentsCreator(MergeParameters params,
                              org.sejda.sambox.pdmodel.PDDocument document)

Method Detail

appendItem

public void appendItem(String text,
                       long pageNumber,
                       org.sejda.sambox.pdmodel.PDPage page)

Adds to the ToC the given text with the given annotation associated

Parameters:

text -

pageNumber -

page -

addToC

public void addToC()
            throws TaskException

Generates a ToC and prepend it to the given document

Throws:

TaskException

addToC

public void addToC(int beforePageNumber)
            throws TaskException

Generates a ToC and inserts it in the doc at before the given page number

Throws:

TaskException

hasToc

public boolean hasToc()

shouldGenerateToC

public boolean shouldGenerateToC()

pageSizeIfNotSet

public void pageSizeIfNotSet(org.sejda.sambox.pdmodel.common.PDRectangle pageSize)

getFontSize

public float getFontSize()

tocNumberOfPages

public long tocNumberOfPages()

Returns:

the number of pages this toc will consist of