org.sejda.model.outline
Interface OutlineSubsetProvider<T>

Type Parameters:

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

All Known Implementing Classes:

ITextOutlineSubsetProvider

public interface OutlineSubsetProvider<T>

Statefull component providing a subset of the document outline.

Author:

Andrea Vacondio

Method Summary

Collection<T>	getOutlineUntillPage(int endPage)
Collection<T>	getOutlineUntillPageWithOffset(int endPage, 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

Collection<T> getOutlineUntillPage(int endPage)
                                   throws TaskException

Parameters:

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

Returns:

collection of item representing 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

Collection<T> getOutlineUntillPageWithOffset(int endPage,
                                             int offset)
                                             throws TaskException

Parameters:

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

Returns:

collection of item representing 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.