public static interface

PSPDFKitViews.PSPDFView

com.pspdfkit.ui.PSPDFKitViews.PSPDFView
Known Indirect Subclasses

Class Overview

Shared interface of all auxiliary views (search view, thumbnail bar, grid, etc.) that are hosted inside the PdfActivity.

Summary

Public Methods
abstract void addOnVisibilityChangedListener(OnVisibilityChangedListener listener)
Register a listener that would like to receive visibility change events.
abstract void clearDocument()
Called by the activity when the view should unbind the previously set document.
abstract PSPDFKitViews.Type getPSPDFViewType()
Returns the type of this view.
abstract void hide()
Called by the activity when the view should hide itself.
abstract boolean isDisplayed()
Called when the activity needs to know the visibility of this view.
abstract void removeOnVisibilityChangedListener(OnVisibilityChangedListener listener)
Unregister a previously registered listener that no longer wants to receive visibility change events.
abstract void setDocument(PdfDocument document, PdfConfiguration configuration)
Called when the document has been loaded and is going to be displayed.
abstract void show()
Called by the activity when the view should make itself visible.

Public Methods

public abstract void addOnVisibilityChangedListener (OnVisibilityChangedListener listener)

Register a listener that would like to receive visibility change events. Whenever the visibility of a managed PSPDFKitViews.PSPDFView changes, all registered listeners will be notified.

Parameters
listener Listener to be added.

public abstract void clearDocument ()

Called by the activity when the view should unbind the previously set document. This may be called in low-memory situations or prior to re-binding another document.

public abstract PSPDFKitViews.Type getPSPDFViewType ()

Returns the type of this view.

Returns

public abstract void hide ()

Called by the activity when the view should hide itself.

public abstract boolean isDisplayed ()

Called when the activity needs to know the visibility of this view. Returns true if this view is visible, otherwise returns false.

public abstract void removeOnVisibilityChangedListener (OnVisibilityChangedListener listener)

Unregister a previously registered listener that no longer wants to receive visibility change events.

Parameters
listener Listener to be removed.

public abstract void setDocument (PdfDocument document, PdfConfiguration configuration)

Called when the document has been loaded and is going to be displayed. This has to be called on the main thread.

Parameters
document Loaded PdfDocument.
configuration Containing document and presentation settings.

public abstract void show ()

Called by the activity when the view should make itself visible.