All Implemented Interfaces:

android.os.Parcelable
```
public final class PdfActivityConfiguration
 implements 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.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`PdfActivityConfiguration.Builder`	Builder used to construct PdfActivityConfiguration instance.
`public class`	`PdfActivityConfiguration.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`public final static Integer`	`NO_THEME`
`private final PdfConfiguration`	`configuration`
`private final String`	`activityTitle`
`private final Integer`	`layout`
`private final Integer`	`theme`
`private final Integer`	`darkTheme`
`private final Boolean`	`isImmersiveMode`
`private final Boolean`	`isShowPageNumberOverlay`
`private final Boolean`	`isSignatureButtonPositionForcedInMainToolbar`
`private final Boolean`	`isShowPageLabels`
`private final Boolean`	`isShowDocumentTitleOverlayEnabled`
`private final Boolean`	`isShowNavigationButtonsEnabled`
`private final ThumbnailBarMode`	`thumbnailBarMode`
`private final Boolean`	`isThumbnailGridEnabled`
`private final Boolean`	`isDocumentEditorEnabled`
`private final Boolean`	`isSearchEnabled`
`private final Boolean`	`isSettingsItemEnabled`
`private final EnumSet<SettingsMenuItemType>`	`settingsMenuItemShown`
`private final SearchType`	`searchType`
`private final Boolean`	`isPrintingEnabled`
`private final UserInterfaceViewMode`	`userInterfaceViewMode`
`private final Boolean`	`hideUserInterfaceWhenCreatingAnnotations`
`private final Boolean`	`isAnnotationListEnabled`
`private final Boolean`	`isDefaultToolbarEnabled`
`private final Boolean`	`isAnnotationListReorderingEnabled`
`private final EnumSet<AnnotationType>`	`listedAnnotationTypes`
`private final Boolean`	`isOutlineEnabled`
`private final Boolean`	`isEmbeddedFilesViewEnabled`
`private final Boolean`	`isBookmarkListEnabled`
`private final Boolean`	`isBookmarkEditingEnabled`
`private final Boolean`	`isDocumentInfoViewEnabled`
`private final Boolean`	`isDocumentInfoViewSeparated`
`private final Integer`	`page`
`private final SearchConfiguration`	`searchConfiguration`
`private final Boolean`	`isAnnotationNoteHintingEnabled`
`private final TabBarHidingMode`	`tabBarHidingMode`
`private final Boolean`	`isVolumeButtonsNavigationEnabled`
`private final Boolean`	`isRedactionUiEnabled`
`private final Boolean`	`isReaderViewEnabled`
`public final static PdfActivityConfiguration.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
PdfActivityConfiguration(PdfConfiguration configuration, String activityTitle, Integer layout, Integer theme, Integer darkTheme, Boolean isImmersiveMode, Boolean isShowPageNumberOverlay, Boolean isSignatureButtonPositionForcedInMainToolbar, Boolean isShowPageLabels, Boolean isShowDocumentTitleOverlayEnabled, Boolean isShowNavigationButtonsEnabled, ThumbnailBarMode thumbnailBarMode, Boolean isThumbnailGridEnabled, Boolean isDocumentEditorEnabled, Boolean isSearchEnabled, Boolean isSettingsItemEnabled, EnumSet<SettingsMenuItemType> settingsMenuItemShown, SearchType searchType, Boolean isPrintingEnabled, UserInterfaceViewMode userInterfaceViewMode, Boolean hideUserInterfaceWhenCreatingAnnotations, Boolean isAnnotationListEnabled, Boolean isDefaultToolbarEnabled, Boolean isAnnotationListReorderingEnabled, EnumSet<AnnotationType> listedAnnotationTypes, Boolean isOutlineEnabled, Boolean isEmbeddedFilesViewEnabled, Boolean isBookmarkListEnabled, Boolean isBookmarkEditingEnabled, Boolean isDocumentInfoViewEnabled, Boolean isDocumentInfoViewSeparated, Integer page, SearchConfiguration searchConfiguration, Boolean isAnnotationNoteHintingEnabled, TabBarHidingMode tabBarHidingMode, Boolean isVolumeButtonsNavigationEnabled, Boolean isRedactionUiEnabled, Boolean isReaderViewEnabled)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PdfActivityConfiguration
```
PdfActivityConfiguration(PdfConfiguration configuration, String activityTitle, Integer layout, Integer theme, Integer darkTheme, Boolean isImmersiveMode, Boolean isShowPageNumberOverlay, Boolean isSignatureButtonPositionForcedInMainToolbar, Boolean isShowPageLabels, Boolean isShowDocumentTitleOverlayEnabled, Boolean isShowNavigationButtonsEnabled, ThumbnailBarMode thumbnailBarMode, Boolean isThumbnailGridEnabled, Boolean isDocumentEditorEnabled, Boolean isSearchEnabled, Boolean isSettingsItemEnabled, EnumSet<SettingsMenuItemType> settingsMenuItemShown, SearchType searchType, Boolean isPrintingEnabled, UserInterfaceViewMode userInterfaceViewMode, Boolean hideUserInterfaceWhenCreatingAnnotations, Boolean isAnnotationListEnabled, Boolean isDefaultToolbarEnabled, Boolean isAnnotationListReorderingEnabled, EnumSet<AnnotationType> listedAnnotationTypes, Boolean isOutlineEnabled, Boolean isEmbeddedFilesViewEnabled, Boolean isBookmarkListEnabled, Boolean isBookmarkEditingEnabled, Boolean isDocumentInfoViewEnabled, Boolean isDocumentInfoViewSeparated, Integer page, SearchConfiguration searchConfiguration, Boolean isAnnotationNoteHintingEnabled, TabBarHidingMode tabBarHidingMode, Boolean isVolumeButtonsNavigationEnabled, Boolean isRedactionUiEnabled, Boolean isReaderViewEnabled)
```
- Method Detail
  - getConfiguration
```
 final PdfConfiguration getConfiguration()
```
    Configuration for the core of PSPDFKit rendering engine.
  - getActivityTitle
```
 final String getActivityTitle()
```
    The title set to the target activity.
  - getLayout
```
@LayoutRes() final Integer getLayout()
```
    the id for the layout used by the launched activity, defaults to R.layout.pspdf__pdf_activity
  - getTheme
```
@StyleRes() final Integer getTheme()
```
    Theme resource used to override default theme of the launched activity.
  - getDarkTheme
```
@StyleRes() final Integer getDarkTheme()
```
    Theme resource used to override dark theme of the launched activity.
  - isImmersiveMode
```
 final Boolean isImmersiveMode()
```
    Indicates whether the immersive mode is activated or not.
  - isShowPageNumberOverlay
```
 final Boolean isShowPageNumberOverlay()
```
    Indicates whether the page number overlay is set to show or not.
  - isSignatureButtonPositionForcedInMainToolbar
```
 final Boolean isSignatureButtonPositionForcedInMainToolbar()
```
    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.
  - isShowPageLabels
```
 final Boolean isShowPageLabels()
```
    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
  - isShowDocumentTitleOverlayEnabled
```
 final Boolean isShowDocumentTitleOverlayEnabled()
```
    Indicates whether the document title overlay is set to show or not.
  - isShowNavigationButtonsEnabled
```
 final Boolean isShowNavigationButtonsEnabled()
```
    Indicates whether the navigation buttons are set to show or not.
  - getThumbnailBarMode
```
 final ThumbnailBarMode getThumbnailBarMode()
```
    Returns the thumbnail bar mode set on the activity.
  - isThumbnailGridEnabled
```
 final Boolean isThumbnailGridEnabled()
```
    Indicates whether the thumbnail grid is enabled or not.
  - isDocumentEditorEnabled
```
 final Boolean isDocumentEditorEnabled()
```
    Indicates whether the document editor is enabled or not.
  - isSearchEnabled
```
 final Boolean isSearchEnabled()
```
    Indicates whether the search is enabled or not.
  - isSettingsItemEnabled
```
 final Boolean isSettingsItemEnabled()
```
    Indicates whether the settings menu item is shown or not.
  - getSettingsMenuItemShown
```
 final EnumSet<SettingsMenuItemType> getSettingsMenuItemShown()
```
    Returns items shown in the settings menu. If none are shown, settings menu icon is not shown either.
  - getSearchType
```
 final SearchType getSearchType()
```
    Returns the search type set on the activity.
  - isPrintingEnabled
```
 final Boolean isPrintingEnabled()
```
    Indicates whether the printing support is enabled or not. Enabled by default.
  - getUserInterfaceViewMode
```
 final UserInterfaceViewMode getUserInterfaceViewMode()
```
    Returns the user interface mode set on the activity.
  - getHideUserInterfaceWhenCreatingAnnotations
```
 final Boolean getHideUserInterfaceWhenCreatingAnnotations()
```
    Returns whether user interface controls should be hidden when annotation creation toolbar is in vertical position (left/right).
  - isAnnotationListEnabled
```
 final Boolean isAnnotationListEnabled()
```
    Indicates whether the list of annotations is enabled or not.
  - isDefaultToolbarEnabled
```
 final Boolean isDefaultToolbarEnabled()
```
    Whether or not the default toolbar is enabled. This is disabled when you need to use the compose com.pspdfkit.jetpack.compose.components.MainToolbar.
  - isAnnotationListReorderingEnabled
```
 final Boolean isAnnotationListReorderingEnabled()
```
    Indicates whether reordering annotations in the annotation list is enabled.
  - getListedAnnotationTypes
```
 final EnumSet<AnnotationType> getListedAnnotationTypes()
```
    Returns a set of annotation types to be displayed in the annotation list.
  - isOutlineEnabled
```
 final Boolean isOutlineEnabled()
```
    Indicates whether the outline is enabled or not.
  - isEmbeddedFilesViewEnabled
```
 final Boolean isEmbeddedFilesViewEnabled()
```
    Indicates whether the embedded files view is enabled or not.
  - isBookmarkListEnabled
```
 final Boolean isBookmarkListEnabled()
```
    Indicates whether the list of bookmarks is enabled or not.
  - isBookmarkEditingEnabled
```
 final Boolean isBookmarkEditingEnabled()
```
    Indicates whether the bookmarks can be edited or not.
  - isDocumentInfoViewEnabled
```
 final Boolean isDocumentInfoViewEnabled()
```
    Indicates whether the document info view is enabled or not.
  - isDocumentInfoViewSeparated
```
 final Boolean isDocumentInfoViewSeparated()
```
    Indicates whether the document info view is a separate window, or displayed as a tab in the outline
  - getPage
```
 final Integer getPage()
```
    Returns the 0-indexed page number at which the document will be initially displayed.
  - getSearchConfiguration
```
 final SearchConfiguration getSearchConfiguration()
```
    Returns the search configuration applied to the search views.
  - isAnnotationNoteHintingEnabled
```
 final Boolean isAnnotationNoteHintingEnabled()
```
    Indicates whether to show visual indicators for annotations that have annotation notes.
  - getTabBarHidingMode
```
 final TabBarHidingMode getTabBarHidingMode()
```
    Returns the tab bar hiding mode set on the activity.
  - isVolumeButtonsNavigationEnabled
```
 final Boolean isVolumeButtonsNavigationEnabled()
```
    Indicates whether to use volume buttons for navigation between document pages.
  - isRedactionUiEnabled
```
 final Boolean isRedactionUiEnabled()
```
    Indicates whether we show the UI to apply redactions when there are com.pspdfkit.annotations.RedactionAnnotation in the document.
  - isReaderViewEnabled
```
 final Boolean isReaderViewEnabled()
```
    Indicates whether we display the reader view and its action icon in the main toolbar.

Class PdfActivityConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PdfActivityConfiguration

Method Detail

getConfiguration

getActivityTitle

getLayout

getTheme

getDarkTheme

isImmersiveMode

isShowPageNumberOverlay

isSignatureButtonPositionForcedInMainToolbar

isShowPageLabels

isShowDocumentTitleOverlayEnabled

isShowNavigationButtonsEnabled

getThumbnailBarMode

isThumbnailGridEnabled

isDocumentEditorEnabled

isSearchEnabled

isSettingsItemEnabled

getSettingsMenuItemShown

getSearchType

isPrintingEnabled

getUserInterfaceViewMode

getHideUserInterfaceWhenCreatingAnnotations

isAnnotationListEnabled

isDefaultToolbarEnabled

isAnnotationListReorderingEnabled

getListedAnnotationTypes

isOutlineEnabled

isEmbeddedFilesViewEnabled

isBookmarkListEnabled

isBookmarkEditingEnabled

isDocumentInfoViewEnabled

isDocumentInfoViewSeparated

getPage

getSearchConfiguration

isAnnotationNoteHintingEnabled

getTabBarHidingMode

isVolumeButtonsNavigationEnabled

isRedactionUiEnabled

isReaderViewEnabled