org.corpus_tools.annis.gui.media

Interface PDFController

All Superinterfaces:

Serializable

All Known Implementing Classes:

PDFControllerImpl

public interface PDFController
extends Serializable

Offers a annis-gui wide interface for controlling pdf viewer.

Author:

Benjamin Weißenfels <b.pixeldrama@gmail.com>

Method Summary

Modifier and Type	Method and Description
void	addPDF(String resultID, PDFViewer pdfViewer) Registers a pdf viewer to the controller.
void	openPDF(String resultID, String pageNumber) Opens a pdf viewer for a specific result id.
int	sizeOfRegisterdPDFViewer() Informs about the number of already registered pdf viewer.

Method Detail

addPDF

void addPDF(String resultID,
            PDFViewer pdfViewer)

Registers a pdf viewer to the controller.

Parameters:

resultID - The result id is an arbitrary String and does not have to be unique for every pdf viewer. If already a pdf viewer is registered for a specific result id, the new pdf viewer is appended.

pdfViewer - The registered pdf viewer.

openPDF

void openPDF(String resultID,
             String pageNumber)

Opens a pdf viewer for a specific result id.

Parameters:

resultID - Is an arbitrary String. If no pdf viewer is registered an IllegalArgumentException is thrown.

pageNumber - Determines the pages of the pdf to render. The String could specify a range (eg. [1-12]) or a singe page (eg. 3).

sizeOfRegisterdPDFViewer

int sizeOfRegisterdPDFViewer()

Informs about the number of already registered pdf viewer.

Returns:

the number of registered pdf viewer.