Class SimpleDocumentListener

    • Constructor Detail

      • SimpleDocumentListener

        SimpleDocumentListener()
    • Method Detail

      • onDocumentLoaded

        @UiThread() void onDocumentLoaded(@NonNull() PdfDocument document)

        Called when document is successfully loaded and the document view has been laid out. This has to be called on the main thread.

        Parameters:
        document - Loaded document instance.
      • onDocumentSave

         boolean onDocumentSave(@NonNull() PdfDocument document, @NonNull() DocumentSaveOptions saveOptions)

        Called before document will be saved. This callback allows cancellation of the save process.

        Parameters:
        document - Instance of document to be saved.
        saveOptions - Save options to be applied to the document.
        Returns:

        true if the document should be saved, false if saving should be cancelled.

      • onDocumentSaved

         void onDocumentSaved(@NonNull() PdfDocument document)

        Called after the document has been saved.

        Parameters:
        document - Instance of document that was saved.
      • onDocumentSaveCancelled

         void onDocumentSaveCancelled(PdfDocument document)

        Called if document saving has been cancelled.

        Parameters:
        document - Instance of document that was saved.
      • onPageClick

         boolean onPageClick(@NonNull() PdfDocument document, @IntRange(from = 0) int pageIndex, @Nullable() MotionEvent event, @Nullable() PointF pagePosition, @Nullable() Annotation clickedAnnotation)

        Called when user taps / clicks on the page.

        Parameters:
        document - Currently opened document.
        pageIndex - Page number of the page being tapped.
        event - MotionEvent that triggered this page click.
        pagePosition - Tapped page position (in PDF page coordinates with origin on bottom left).
        clickedAnnotation - Annotation that was tapped, or null if no annotation was tapped.
        Returns:

        true if tap was handled by this DocumentListener and should not be handled by PSPDFKit anymore. If returning false PSPDFKit will continue executing it's default action.

      • onDocumentClick

         boolean onDocumentClick()

        Called when the user taps / clicks on the document, not the page itself but on the side (if visible).

        Returns:

        true if tap is handled or false if PSPDFKit should execute it's default action.

      • onPageChanged

         void onPageChanged(@NonNull() PdfDocument document, @IntRange(from = 0) int pageIndex)

        Called when user scrolled to a new page.

        Parameters:
        document - Currently opened document.
        pageIndex - Page number of new page.
      • onDocumentZoomed

         void onDocumentZoomed(@NonNull() PdfDocument document, @IntRange(from = 0) int pageIndex, float scaleFactor)

        Called when a user zooms a document.

        Parameters:
        document - Current document.
        pageIndex - The number of the page that the was zoomed.
        scaleFactor - The current scale factor.
      • onPageUpdated

         void onPageUpdated(@NonNull() PdfDocument document, @IntRange(from = 0) int pageIndex)

        Called when content of page with pageIndex has changed (for example due to annotation or form field being updated). All views displaying this page need to refresh.

        Parameters:
        pageIndex - Page index of the updated page.