pspdfkit/com.pspdfkit.configuration.activity/PdfActivityConfiguration

PdfActivityConfiguration

data class PdfActivityConfiguration(val configuration: PdfConfiguration, val activityTitle: String?, val layout: Int, val theme: Int, val darkTheme: Int, val isImmersiveMode: Boolean, val isShowPageNumberOverlay: Boolean, val isSignatureButtonPositionForcedInMainToolbar: Boolean, val isShowPageLabels: Boolean, val isShowDocumentTitleOverlayEnabled: Boolean, val isShowNavigationButtonsEnabled: Boolean, val thumbnailBarMode: ThumbnailBarMode, val isThumbnailGridEnabled: Boolean, val isDocumentEditorEnabled: Boolean, val isSearchEnabled: Boolean, val isSettingsItemEnabled: Boolean, val settingsMenuItemShown: EnumSet<SettingsMenuItemType>, val searchType: SearchType, val isPrintingEnabled: Boolean, val userInterfaceViewMode: UserInterfaceViewMode, val hideUserInterfaceWhenCreatingAnnotations: Boolean, val isAnnotationListEnabled: Boolean, val isDefaultToolbarEnabled: Boolean, val isAnnotationListReorderingEnabled: Boolean, val listedAnnotationTypes: EnumSet<AnnotationType>, val isOutlineEnabled: Boolean, val isEmbeddedFilesViewEnabled: Boolean, val isBookmarkListEnabled: Boolean, val isBookmarkEditingEnabled: Boolean, val isDocumentInfoViewEnabled: Boolean, val isDocumentInfoViewSeparated: Boolean, @IntRange(from = 0) val page: Int, val searchConfiguration: SearchConfiguration?, val isAnnotationNoteHintingEnabled: Boolean, val tabBarHidingMode: TabBarHidingMode, val isVolumeButtonsNavigationEnabled: Boolean, val isRedactionUiEnabled: Boolean, val isReaderViewEnabled: Boolean) : Parcelable

Configuration for PDF display in a separate activity or com.pspdfkit.ui.PdfUiFragment. Use PdfActivityConfiguration.Builder.build to create an instance of this class.

Constructors

constructor(configuration: PdfConfiguration, activityTitle: String?, layout: Int, theme: Int, darkTheme: Int, isImmersiveMode: Boolean, isShowPageNumberOverlay: Boolean, isSignatureButtonPositionForcedInMainToolbar: Boolean, isShowPageLabels: Boolean, isShowDocumentTitleOverlayEnabled: Boolean, isShowNavigationButtonsEnabled: Boolean, thumbnailBarMode: ThumbnailBarMode, isThumbnailGridEnabled: Boolean, isDocumentEditorEnabled: Boolean, isSearchEnabled: Boolean, isSettingsItemEnabled: Boolean, settingsMenuItemShown: EnumSet<SettingsMenuItemType>, searchType: SearchType, isPrintingEnabled: Boolean, userInterfaceViewMode: UserInterfaceViewMode, hideUserInterfaceWhenCreatingAnnotations: Boolean, isAnnotationListEnabled: Boolean, isDefaultToolbarEnabled: Boolean, isAnnotationListReorderingEnabled: Boolean, listedAnnotationTypes: EnumSet<AnnotationType>, isOutlineEnabled: Boolean, isEmbeddedFilesViewEnabled: Boolean, isBookmarkListEnabled: Boolean, isBookmarkEditingEnabled: Boolean, isDocumentInfoViewEnabled: Boolean, isDocumentInfoViewSeparated: Boolean, @IntRange(from = 0) page: Int, searchConfiguration: SearchConfiguration?, isAnnotationNoteHintingEnabled: Boolean, tabBarHidingMode: TabBarHidingMode, isVolumeButtonsNavigationEnabled: Boolean, isRedactionUiEnabled: Boolean, isReaderViewEnabled: Boolean)

Types

Builder

class Builder

Builder used to construct PdfActivityConfiguration instance.

Companion

object Companion

Properties

activityTitle

val activityTitle: String?

The title set to the target activity.

configuration

val configuration: PdfConfiguration

Configuration for the core of PSPDFKit rendering engine.

darkTheme

@get:StyleRes

val darkTheme: Int

Theme resource used to override dark theme of the launched activity.

hideUserInterfaceWhenCreatingAnnotations

val hideUserInterfaceWhenCreatingAnnotations: Boolean

Returns whether user interface controls should be hidden when annotation creation toolbar is in vertical position (left/right).

isAnnotationListEnabled

val isAnnotationListEnabled: Boolean

Indicates whether the list of annotations is enabled or not.

isAnnotationListReorderingEnabled

val isAnnotationListReorderingEnabled: Boolean

Indicates whether reordering annotations in the annotation list is enabled.

isAnnotationNoteHintingEnabled

val isAnnotationNoteHintingEnabled: Boolean

Indicates whether to show visual indicators for annotations that have annotation notes.

isBookmarkEditingEnabled

val isBookmarkEditingEnabled: Boolean

Indicates whether the bookmarks can be edited or not.

isBookmarkListEnabled

val isBookmarkListEnabled: Boolean

Indicates whether the list of bookmarks is enabled or not.

isDefaultToolbarEnabled

val isDefaultToolbarEnabled: Boolean

Whether or not the default toolbar is enabled. This is disabled when you need to use the compose com.pspdfkit.jetpack.compose.components.MainToolbar.

isDocumentEditorEnabled

val isDocumentEditorEnabled: Boolean

Indicates whether the document editor is enabled or not.

isDocumentInfoViewEnabled

val isDocumentInfoViewEnabled: Boolean

Indicates whether the document info view is enabled or not.

isDocumentInfoViewSeparated

val isDocumentInfoViewSeparated: Boolean

Indicates whether the document info view is a separate window, or displayed as a tab in the outline

isEmbeddedFilesViewEnabled

val isEmbeddedFilesViewEnabled: Boolean

Indicates whether the embedded files view is enabled or not.

isImmersiveMode

val isImmersiveMode: Boolean

Indicates whether the immersive mode is activated or not.

isOutlineEnabled

val isOutlineEnabled: Boolean

Indicates whether the outline is enabled or not.

isPrintingEnabled

val isPrintingEnabled: Boolean

Indicates whether the printing support is enabled or not. Enabled by default.

isReaderViewEnabled

val isReaderViewEnabled: Boolean

Indicates whether we display the reader view and its action icon in the main toolbar.

isRedactionUiEnabled

val isRedactionUiEnabled: Boolean

Indicates whether we show the UI to apply redactions when there are com.pspdfkit.annotations.RedactionAnnotation in the document.

isSearchEnabled

val isSearchEnabled: Boolean

Indicates whether the search is enabled or not.

isSettingsItemEnabled

val isSettingsItemEnabled: Boolean

Indicates whether the settings menu item is shown or not.

isShowDocumentTitleOverlayEnabled

val isShowDocumentTitleOverlayEnabled: Boolean

Indicates whether the document title overlay is set to show or not.

isShowNavigationButtonsEnabled

val isShowNavigationButtonsEnabled: Boolean

Indicates whether the navigation buttons are set to show or not.

isShowPageLabels

val isShowPageLabels: Boolean

Indicates whether the page labels are set to show or not. Affects the com.pspdfkit.ui.PdfOutlineView view and the com.pspdfkit.ui.search.PdfSearchViewModular

isShowPageNumberOverlay

val isShowPageNumberOverlay: Boolean

Indicates whether the page number overlay is set to show or not.

isSignatureButtonPositionForcedInMainToolbar

val isSignatureButtonPositionForcedInMainToolbar: Boolean

Indicates whether the signature button position is forced in the main toolbar or not. The button's visibility in the main toolbar defaults to false when the license uses Annotation Editing, as normally the annotation signature creation can be accessed via the Annotation Creation Toolbar. For the special case where the license includes Electronic Signatures without Annotation Editing, the signature button will be included in the main toolbar rather than in the Annotation Creation Toolbar.

isThumbnailGridEnabled

val isThumbnailGridEnabled: Boolean

Indicates whether the thumbnail grid is enabled or not.

isVolumeButtonsNavigationEnabled

val isVolumeButtonsNavigationEnabled: Boolean

Indicates whether to use volume buttons for navigation between document pages.

layout

@get:LayoutRes

val layout: Int

the id for the layout used by the launched activity, defaults to R.layout.pspdf__pdf_activity

listedAnnotationTypes

val listedAnnotationTypes: EnumSet<AnnotationType>