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.

Types

Builder

open class Builder

Builder used to construct a PdfActivityConfiguration instance.

SearchType

@Documented

@Retention(value = RetentionPolicy.SOURCE )

annotation class SearchType

Type of search.

Functions

getActivityTitle

@Nullable

abstract fun getActivityTitle(): String

Returns the title set to the target activity.

getConfiguration

@NonNull

abstract fun getConfiguration(): PdfConfiguration

Returns configuration for the document.

getDarkTheme

@StyleRes

abstract fun getDarkTheme(): Int

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

getLayout

@LayoutRes

abstract fun getLayout(): Int

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

getListedAnnotationTypes

abstract fun getListedAnnotationTypes(): EnumSet<AnnotationType>

Returns a set of annotation types to be displayed in the annotation list.

getSearchConfiguration

@Nullable

abstract fun getSearchConfiguration(): SearchConfiguration

Returns the search configuration applied to the search views.

getSearchType

@PdfActivityConfiguration.SearchType

abstract fun getSearchType(): Int

Returns the search type set on the activity.

getSettingsMenuItemShown

abstract fun getSettingsMenuItemShown(): EnumSet<SettingsMenuItemType>

Returns items shown in the settings menu.

getTabBarHidingMode

@NonNull

abstract fun getTabBarHidingMode(): TabBarHidingMode

Returns the tab bar hiding mode set on the activity.

getTheme

@StyleRes

abstract fun getTheme(): Int

Returns theme resource used to override default theme of the launched activity.

getThumbnailBarMode

@NonNull

abstract fun getThumbnailBarMode(): ThumbnailBarMode

Returns the thumbnail bar mode set on the activity.

getUserInterfaceViewMode

@NonNull

abstract fun getUserInterfaceViewMode(): UserInterfaceViewMode

Returns the user interface mode set on the activity.

hideUserInterfaceWhenCreatingAnnotations

abstract fun hideUserInterfaceWhenCreatingAnnotations(): Boolean

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

isAnnotationListEnabled

abstract fun isAnnotationListEnabled(): Boolean

Indicates whether the list of annotations is enabled or not.

isAnnotationListReorderingEnabled

abstract fun isAnnotationListReorderingEnabled(): Boolean

Indicates whether reordering annotations in the annotation list is enabled.

isAnnotationNoteHintingEnabled

abstract fun isAnnotationNoteHintingEnabled(): Boolean

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

isBookmarkEditingEnabled

abstract fun isBookmarkEditingEnabled(): Boolean

Indicates whether the bookmarks can be edited or not.

isBookmarkListEnabled

abstract fun isBookmarkListEnabled(): Boolean

Indicates whether the list of bookmarks is enabled or not.

isDocumentEditorEnabled

abstract fun isDocumentEditorEnabled(): Boolean

Indicates whether the document editor is enabled or not.

isDocumentInfoViewEnabled

abstract fun isDocumentInfoViewEnabled(): Boolean

Indicates whether the document info view is enabled or not.

isDocumentInfoViewSeparated

abstract fun isDocumentInfoViewSeparated(): Boolean

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

isImmersiveMode

abstract fun isImmersiveMode(): Boolean

Indicates whether the immersive mode is activated or not.

isOutlineEnabled

abstract fun isOutlineEnabled(): Boolean

Indicates whether the outline is enabled or not.

isPrintingEnabled

abstract fun isPrintingEnabled(): Boolean

Indicates whether the printing support is enabled or not.

isReaderViewEnabled

abstract fun isReaderViewEnabled(): Boolean

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

isRedactionUiEnabled

abstract fun isRedactionUiEnabled(): Boolean

Indicates whether we show the UI to apply redactions when there are in the document.

isSearchEnabled

abstract fun isSearchEnabled(): Boolean

Indicates whether the search is enabled or not.

isSettingsItemEnabled

abstract fun isSettingsItemEnabled(): Boolean

Indicates whether the settings menu item is shown or not.

isShowDocumentTitleOverlayEnabled

abstract fun isShowDocumentTitleOverlayEnabled(): Boolean

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

isShowNavigationButtonsEnabled

abstract fun isShowNavigationButtonsEnabled(): Boolean

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

isShowPageLabels

abstract fun isShowPageLabels(): Boolean

Indicates whether the page labels are set to show or not.

isShowPageNumberOverlay

abstract fun isShowPageNumberOverlay(): Boolean

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

isSignatureButtonPositionForcedInMainToolbar

abstract fun isSignatureButtonPositionForcedInMainToolbar(): Boolean

Indicates whether the signature button position is forced in the main toolbar or not.

isThumbnailGridEnabled

abstract fun isThumbnailGridEnabled(): Boolean

Indicates whether the thumbnail grid is enabled or not.

isVolumeButtonsNavigationEnabled

abstract fun isVolumeButtonsNavigationEnabled(): Boolean

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

page

@IntRange(from = 0 )

abstract fun page(): Int

Returns the 0-indexed page number at which the document will be initially displayed.

Properties

DEFAULT_LISTED_ANNOTATION_TYPES

val DEFAULT_LISTED_ANNOTATION_TYPES: EnumSet<AnnotationType>

Annotation types listed by default.

NO_THEME

val NO_THEME: Int

Represents the default resource id for the theme, meaning the theme is not set.

SEARCH_INLINE

val SEARCH_INLINE: Int

Search type: inline.

SEARCH_MODULAR

val SEARCH_MODULAR: Int

Search type: modular.