org.sejda.model.outline

Interface OutlineSubsetProvider<T>

Type Parameters:

T - generic type for the outline returned by the provider.

public interface OutlineSubsetProvider<T>

Statefull component providing a subset of the document outline.

Author:

Andrea Vacondio

Method Summary

Methods

Modifier and Type	Method and Description
T	getOutlineUntillPage(int endPage)
T	getOutlineUntillPageWithOffset(int endPage, int offset)
T	getOutlineWithOffset(int offset)
void	startPage(int startPage) Sets the start page from which the component will provide outline.

Method Detail

startPage

void startPage(int startPage)

Sets the start page from which the component will provide outline.

Parameters:

startPage -

getOutlineUntillPage

T getOutlineUntillPage(int endPage)
                       throws TaskException

Parameters:

endPage - end page till which the component will provide bookmarks.

Returns:

the document outline from start page to the provided end page.

Throws:

TaskException - if the start page is not set or the end page is before the start.

getOutlineUntillPageWithOffset

T getOutlineUntillPageWithOffset(int endPage,
                               int offset)
                                 throws TaskException

Parameters:

endPage - end page till which the component will provide bookmarks.

offset - page numbers should be shifted

Returns:

the document outline from start page to the provided end page with the offset applied.

Throws:

TaskException - if the start page is not set or the end page is before the start.

getOutlineWithOffset

T getOutlineWithOffset(int offset)

Parameters:

offset - page numbers should be shifted

Returns:

the whole document outline with the offset applied.