pspdfkit/com.pspdfkit.ui/PSPDFKitViews

PSPDFKitViews

interface PSPDFKitViews

Interface for convenient access to views in a PSPDFKit activity.

Types

Link copied to clipboard
interface PSPDFView
Shared interface of all auxiliary views (search view, thumbnail bar, grid, etc.
Link copied to clipboard
enum Type
Known auxiliary view types.

Functions

Link copied to clipboard
abstract fun addOnVisibilityChangedListener(@NonNull listener: OnVisibilityChangedListener)
Add on visibility changed listener to every instantiated view.
Link copied to clipboard
@NonNull
abstract fun getActiveViewType(): PSPDFKitViews.Type
Returns currently displayed view over the document.
Link copied to clipboard
@Nullable
abstract fun getAudioInspector(): AudioView
Returns currently instantiated AudioView.
Link copied to clipboard
Link copied to clipboard
@Nullable
abstract fun getCreateTextBlockButtonsContainer(): ViewGroup
container view for the create-textblock buttons
Link copied to clipboard
@Nullable
abstract fun getDocumentInfoView(): PdfDocumentInfoView
Returns currently instantiated PdfDocumentInfoView.
Link copied to clipboard
@Nullable
abstract fun getDocumentTitleOverlayView(): TextView
Returns the currently instantiated document title view.
Link copied to clipboard
@Nullable
abstract fun getEmptyView(): View
Returns currently instantiated view that is shown when no document is loaded.
Link copied to clipboard
@Nullable
abstract fun getFormEditingBarView(): FormEditingBar
Returns currently instantiated FormEditingBar.
Link copied to clipboard
@Nullable
abstract fun getMainPageCreateTextBlockButton(): FloatingActionButton
create-textblock button for the main page
Link copied to clipboard
@Nullable
abstract fun getMeasurementScaleView(): MeasurementScaleView
Returns currently instantiated MeasurementScaleView.
Link copied to clipboard
@Nullable
abstract fun getNavigateBackButton(): View
Returns the currently instantiate navigate back button.
Link copied to clipboard
@Nullable
abstract fun getNavigateForwardButton(): View
Returns the currently instantiate navigate forward button.
Link copied to clipboard
@Nullable
abstract fun getOutlineView(): PdfOutlineView
Returns currently instantiated PdfOutlineView.
Link copied to clipboard
@Nullable
abstract fun getPageNumberOverlayView(): TextView
Returns currently instantiated page number view.
Link copied to clipboard
@Nullable
abstract fun getReaderView(): PdfReaderView
Returns currently instantiated PdfReaderView.
Link copied to clipboard
@Nullable
abstract fun getRedactionView(): RedactionView
Returns currently instantiated RedactionView.
Link copied to clipboard
@Nullable
abstract fun getSearchView(): PdfSearchView
Returns currently instantiated PdfSearchView.
Link copied to clipboard
@Nullable
abstract fun getSecondPageCreateTextBlockButton(): FloatingActionButton
create-textblock button for the second page (in double page mode)
Link copied to clipboard
@Nullable
abstract fun getTabBar(): PdfTabBar
Returns the currently instantiated tab bar view.
Link copied to clipboard
@Nullable
abstract fun getThumbnailBarView(): PdfThumbnailBar
Returns currently instantiated PdfThumbnailBar.
Link copied to clipboard
@Nullable
abstract fun getThumbnailGridView(): PdfThumbnailGrid
Returns currently instantiated PdfThumbnailGrid.
Link copied to clipboard
@Nullable
abstract fun getViewByType(type: PSPDFKitViews.Type): PSPDFKitViews.PSPDFView
Returns view by the specified type.
Link copied to clipboard
abstract fun onRestoreViewHierarchyState(@NonNull state: Bundle)
Called after activity recreation, to restore state of views that otherwise wouldn't be restored.
Link copied to clipboard
abstract fun onSaveViewHierarchyState(outState: Bundle)
Called while persisting the activity to persist state of views that otherwise wouldn't be stored.
Link copied to clipboard
abstract fun removeOnVisibilityChangedListener(@NonNull listener: OnVisibilityChangedListener)
Remove on visibility changed listener from every instantiated view.
Link copied to clipboard
abstract fun resetDocument()
Reset/clear the document on all instantiated views.
Link copied to clipboard
@UiThread
abstract fun setDocument(@NonNull document: PdfDocument)
Sets the document to all instantiated views.
Link copied to clipboard
abstract fun showView(viewType: PSPDFKitViews.Type): Boolean
Similar to toggleView but not hiding the view if it is already visible.
Link copied to clipboard
abstract fun toggleView(typeToToggle: PSPDFKitViews.Type): Boolean
abstract fun toggleView(typeToToggle: PSPDFKitViews.Type, showDelay: Long): Boolean
Toggles the view with the specified type.