pspdfkit/com.pspdfkit.ui/PdfActivity

PdfActivity

open class PdfActivity : AppCompatActivity, PdfUi, PdfActivityListener, PdfActivityComponentsApi

Activity with fully integrated views and behaviour. Can be invoked by the simple helper methods showDocument and showDocument. For more advanced customization use to generate an Intent with proper parameters.

Inheritors

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
@get:NonNull
open val implementation: PdfUiImpl
Link copied to clipboard
@IdRes
val MENU_OPTION_DOCUMENT_INFO: Int
Id of the document infoview menu item.
Link copied to clipboard
@IdRes
val MENU_OPTION_EDIT_ANNOTATIONS: Int
Id of the edit-annotations menu item.
Link copied to clipboard
@IdRes
val MENU_OPTION_EDIT_CONTENT: Int
Id of the edit-content menu item.
Link copied to clipboard
@IdRes
val MENU_OPTION_OUTLINE: Int
Id of the outline view menu item.
Link copied to clipboard
@IdRes
val MENU_OPTION_READER_VIEW: Int
Id of the reader view menu item.
Link copied to clipboard
@IdRes
val MENU_OPTION_SEARCH: Int
Id of the search menu item.
Link copied to clipboard
@IdRes
val MENU_OPTION_SETTINGS: Int
Id of the settings menu item.
Link copied to clipboard
@IdRes
val MENU_OPTION_SHARE: Int
Id of the share menu item.
Link copied to clipboard
@IdRes
val MENU_OPTION_SIGNATURE: Int
Id of the signature menu item.
Link copied to clipboard
@IdRes
val MENU_OPTION_THUMBNAIL_GRID: Int
Id of the thumbnail grid menu item.

Functions

Link copied to clipboard
open fun dispatchKeyEvent(event: KeyEvent): Boolean
Link copied to clipboard
@NonNull
open fun getConfiguration(): PdfActivityConfiguration
Returns the PdfActivityConfiguration that was provided while launching this activity.
Link copied to clipboard
open fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent)
Link copied to clipboard
open fun onBackPressed()
Link copied to clipboard
open fun onCreateOptionsMenu(menu: Menu): Boolean
Link copied to clipboard
open fun onDocumentClick(): Boolean
Called when the user taps / clicks on the document, not the page itself but on the side (if visible).
Link copied to clipboard
@UiThread
open fun onDocumentLoaded(@NonNull document: PdfDocument)
Called when document is successfully loaded and the document view has been laid out.
Link copied to clipboard
open fun onDocumentLoadFailed(@NonNull exception: Throwable)
Called if document loading has failed.
Link copied to clipboard
open fun onDocumentSave(@NonNull document: PdfDocument, @NonNull saveOptions: DocumentSaveOptions): Boolean
Called before document will be saved.
Link copied to clipboard
open fun onDocumentSaveCancelled(document: PdfDocument)
Called if document saving has been cancelled.
Link copied to clipboard
open fun onDocumentSaved(@NonNull document: PdfDocument)
Called after the document has been saved.
Link copied to clipboard
open fun onDocumentSaveFailed(@NonNull document: PdfDocument, @NonNull exception: Throwable)
Called if document saving has failed.
Link copied to clipboard
open fun onDocumentZoomed(@NonNull document: PdfDocument, @IntRange(from = 0) pageIndex: Int, scaleFactor: Float)
Called when a user zooms a document.
Link copied to clipboard
@NonNull
open fun onGenerateMenuItemIds(@NonNull menuItems: List<Integer>): List<Integer>
Called before the main menu items are set to be ordered.
Link copied to clipboard
open fun onGetShowAsAction(menuItemId: Int, defaultShowAsAction: Int): Int
Link copied to clipboard
Link copied to clipboard
open fun onPageChanged(@NonNull document: PdfDocument, @IntRange(from = 0) pageIndex: Int)
Called when user scrolled to a new page.
Link copied to clipboard
open fun onPageClick(@NonNull document: PdfDocument, @IntRange(from = 0) pageIndex: Int, @Nullable event: MotionEvent, @Nullable pagePosition: PointF, @Nullable clickedAnnotation: Annotation): Boolean
Called when user taps / clicks on the page.
Link copied to clipboard
open fun onPageUpdated(@NonNull document: PdfDocument, @IntRange(from = 0) pageIndex: Int)
Called when content of page with pageIndex has changed (for example due to annotation or form field being updated).
Link copied to clipboard
open fun onPrepareOptionsMenu(menu: Menu): Boolean
Link copied to clipboard
open fun onSetActivityTitle(@NonNull configuration: PdfActivityConfiguration, @Nullable document: PdfDocument)
Called when activity title must be set - before and after document was loaded.
Link copied to clipboard
open fun onTrimMemory(level: Int)
Link copied to clipboard
open fun onUserInteraction()
Link copied to clipboard
open fun onUserInterfaceVisibilityChanged(visible: Boolean)
Called when user interface visibility have changed.
Link copied to clipboard
open fun onWindowFocusChanged(hasFocus: Boolean)
Link copied to clipboard
open fun setConfiguration(@NonNull configuration: PdfActivityConfiguration)
Replaces activity configuration.
Link copied to clipboard
open fun showDocument(@NonNull context: Context, @NonNull documentUri: Uri, @Nullable configuration: PdfActivityConfiguration)
open fun showDocument(@NonNull context: Context, @NonNull documentUri: Uri, @Nullable password: String, @Nullable configuration: PdfActivityConfiguration)
Opens a new PdfActivity displaying a passed document.
Link copied to clipboard
open fun showImage(@NonNull context: Context, @NonNull imageUri: Uri, @Nullable configuration: PdfActivityConfiguration)
Opens a new PdfActivity displaying a passed image document.