com.qoppa.pdfViewer.history

Interface LocationHistory

public interface LocationHistory

This interface provides information about the document "views" while browsing a document. Do not implement this interface. It is solely intended to provide document browsing view information. When a document is loaded in PDFViewerBean, an implementation of this interface is created and is managed by PDFViewerBean while the document is browsed. It can be used to update application level "Next"/"Prev" navigation buttons along with a HistoryListener.

See jPDFViewerSamples/history/SimpleDocumentHistory.java for a simple application with "Next"/"Prev" buttons. See jPDFViewerSamples/history/MultipleDocumentHistory.java for a sample application that maintains view history for multiple documents.

Author:

Qoppa Software

Method Summary

Modifier and Type	Method and Description
void	clearNext() Removes any subsequent document views.
boolean	hasNext() Returns true if there is a subsequent document view in the LocationHistory.
boolean	hasPrevious() Returns true if there is a previous document view in the LocationHistory.

Method Detail

clearNext

void clearNext()

Removes any subsequent document views. This method is generally not needed unless implementing document view history for multiple documents.

See jPDFViewerSamples.history.MultipleDocumentHistory for an example of how this method is used.

hasNext

boolean hasNext()

Returns true if there is a subsequent document view in the LocationHistory.

Returns:

true if there is a subsequent document view, false otherwise

hasPrevious

boolean hasPrevious()

Returns true if there is a previous document view in the LocationHistory.

Returns:

true if there is a previous document view, false otherwise