pspdfkit/com.pspdfkit.configuration.activity/PdfActivityConfiguration

PdfActivityConfiguration

abstract class PdfActivityConfiguration : Parcelable

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

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
open class Builder
Builder used to construct a PdfActivityConfiguration instance.
Link copied to clipboard
@Documented
@Retention(value = RetentionPolicy.SOURCE)
annotation class SearchType
Type of search.

Properties

Link copied to clipboard
val DEFAULT_LISTED_ANNOTATION_TYPES: EnumSet<AnnotationType>
Annotation types listed by default.
Link copied to clipboard
val NO_THEME: Int = -1
Represents the default resource id for the theme, meaning the theme is not set.
Link copied to clipboard
val SEARCH_INLINE: Int = 1
Search type: inline.
Link copied to clipboard
val SEARCH_MODULAR: Int = 2
Search type: modular.

Functions

Link copied to clipboard
@Nullable
abstract fun getActivityTitle(): String
Returns the title set to the target activity.
Link copied to clipboard
@NonNull
abstract fun getConfiguration(): PdfConfiguration
Returns configuration for the document.
Link copied to clipboard
@StyleRes
abstract fun getDarkTheme(): Int
Returns theme resource used to override dark theme of the launched activity.
Link copied to clipboard
@LayoutRes
abstract fun getLayout(): Int
Returns the id for the layout used by the launched activity, defaults to pspdf__pdf_activity..
Link copied to clipboard
abstract fun getListedAnnotationTypes(): EnumSet<AnnotationType>
Returns a set of annotation types to be displayed in the annotation list.
Link copied to clipboard
@Nullable
abstract fun getSearchConfiguration(): SearchConfiguration
Returns the search configuration applied to the search views.
Link copied to clipboard
@PdfActivityConfiguration.SearchType
abstract fun getSearchType(): Int
Returns the search type set on the activity.
Link copied to clipboard
abstract fun getSettingsMenuItemShown(): EnumSet<SettingsMenuItemType>
Returns items shown in the settings menu.
Link copied to clipboard
@NonNull
abstract fun getTabBarHidingMode(): TabBarHidingMode
Returns the tab bar hiding mode set on the activity.
Link copied to clipboard
@StyleRes
abstract fun getTheme(): Int
Returns theme resource used to override default theme of the launched activity.
Link copied to clipboard
@NonNull
abstract fun getThumbnailBarMode(): ThumbnailBarMode
Returns the thumbnail bar mode set on the activity.
Link copied to clipboard
@NonNull
abstract fun getUserInterfaceViewMode(): UserInterfaceViewMode
Returns the user interface mode set on the activity.
Link copied to clipboard
abstract fun hideUserInterfaceWhenCreatingAnnotations(): Boolean
Returns whether user interface controls should be hidden when annotation creation toolbar is in vertical position (left/right).
Link copied to clipboard
abstract fun isAnnotationListEnabled(): Boolean
Indicates whether the list of annotations is enabled or not.
Link copied to clipboard
abstract fun isAnnotationListReorderingEnabled(): Boolean
Indicates whether reordering annotations in the annotation list is enabled.
Link copied to clipboard
abstract fun isAnnotationNoteHintingEnabled(): Boolean
Indicates whether to show visual indicators for annotations that have annotation notes.
Link copied to clipboard
abstract fun isBookmarkEditingEnabled(): Boolean
Indicates whether the bookmarks can be edited or not.
Link copied to clipboard
abstract fun isBookmarkListEnabled(): Boolean
Indicates whether the list of bookmarks is enabled or not.
Link copied to clipboard
Link copied to clipboard
abstract fun isDocumentEditorEnabled(): Boolean
Indicates whether the document editor is enabled or not.
Link copied to clipboard
abstract fun isDocumentInfoViewEnabled(): Boolean
Indicates whether the document info view is enabled or not.
Link copied to clipboard
abstract fun isDocumentInfoViewSeparated(): Boolean
Indicates whether the document info view is a separate window, or displayed as a tab in the outline
Link copied to clipboard
abstract fun isEmbeddedFilesViewEnabled(): Boolean
Indicates whether the embedded files view is enabled or not.
Link copied to clipboard
abstract fun isImmersiveMode(): Boolean
Indicates whether the immersive mode is activated or not.
Link copied to clipboard
abstract fun isOutlineEnabled(): Boolean
Indicates whether the outline is enabled or not.
Link copied to clipboard
abstract fun isPrintingEnabled(): Boolean
Indicates whether the printing support is enabled or not.
Link copied to clipboard
abstract fun isReaderViewEnabled(): Boolean
Indicates whether we display the reader view and its action icon in the main toolbar.
Link copied to clipboard
abstract fun isRedactionUiEnabled(): Boolean
Indicates whether we show the UI to apply redactions when there are in the document.
Link copied to clipboard
abstract fun isSearchEnabled(): Boolean
Indicates whether the search is enabled or not.
Link copied to clipboard
abstract fun isSettingsItemEnabled(): Boolean
Indicates whether the settings menu item is shown or not.
Link copied to clipboard
abstract fun isShowDocumentTitleOverlayEnabled(): Boolean
Indicates whether the document title overlay is set to show or not.
Link copied to clipboard
abstract fun isShowNavigationButtonsEnabled(): Boolean
Indicates whether the navigation buttons are set to show or not.
Link copied to clipboard
abstract fun isShowPageLabels(): Boolean
Indicates whether the page labels are set to show or not.
Link copied to clipboard
abstract fun isShowPageNumberOverlay(): Boolean
Indicates whether the page number overlay is set to show or not.
abstract fun isSignatureButtonPositionForcedInMainToolbar(): Boolean
Indicates whether the signature button position is forced in the main toolbar or not.
Link copied to clipboard
abstract fun isThumbnailGridEnabled(): Boolean
Indicates whether the thumbnail grid is enabled or not.
Link copied to clipboard
abstract fun isVolumeButtonsNavigationEnabled(): Boolean
Indicates whether to use volume buttons for navigation between document pages.
Link copied to clipboard
@IntRange(from = 0)
abstract fun page(): Int
Returns the 0-indexed page number at which the document will be initially displayed.