public abstract class

PdfActivityConfiguration

extends Object
implements Parcelable
java.lang.Object
   ↳ com.pspdfkit.configuration.activity.PdfActivityConfiguration

Class Overview

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

Summary

Nested Classes
class PdfActivityConfiguration.Builder Builder used to construct a PdfActivityConfiguration instance. 
@interface PdfActivityConfiguration.SearchType Type of search. 
Constants
int NO_THEME Represents the default resource id for the theme, meaning the theme is not set.
int SEARCH_INLINE Search type: inline.
int SEARCH_MODULAR Search type: modular.
[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final EnumSet<AnnotationType> DEFAULT_LISTED_ANNOTATION_TYPES Annotation types listed by default.
Public Constructors
PdfActivityConfiguration()
Public Methods
abstract String getActivityTitle()
Returns the title set to the target activity.
abstract PdfConfiguration getConfiguration()
Returns configuration for the document.
abstract int getDarkTheme()
Returns theme resource used to override dark theme of the launched activity.
abstract int getLayout()
Returns the id for the layout used by the launched activity, defaults to pspdf__pdf_activity..
abstract EnumSet<AnnotationType> getListedAnnotationTypes()
Returns a set of annotation types to be displayed in the annotation list.
abstract SearchConfiguration getSearchConfiguration()
Returns the search configuration applied to the search views.
abstract int getSearchType()
Returns the search type set on the activity.
abstract EnumSet<SettingsMenuItemType> getSettingsMenuItemShown()
Returns items shown in the settings menu.
abstract TabBarHidingMode getTabBarHidingMode()
Returns the tab bar hiding mode set on the activity.
abstract int getTheme()
Returns theme resource used to override default theme of the launched activity.
abstract ThumbnailBarMode getThumbnailBarMode()
Returns the thumbnail bar mode set on the activity.
abstract UserInterfaceViewMode getUserInterfaceViewMode()
Returns the user interface mode set on the activity.
abstract boolean hideUserInterfaceWhenCreatingAnnotations()
Returns whether user interface controls should be hidden when annotation creation toolbar is in vertical position (left/right).
abstract boolean isAnnotationListEnabled()
Indicates whether the list of annotations is enabled or not.
abstract boolean isAnnotationListReorderingEnabled()
Indicates whether reordering annotations in the annotation list is enabled.
abstract boolean isAnnotationNoteHintingEnabled()
Indicates whether to show visual indicators for annotations that have annotation notes.
abstract boolean isBookmarkEditingEnabled()
Indicates whether the bookmarks can be edited or not.
abstract boolean isBookmarkListEnabled()
Indicates whether the list of bookmarks is enabled or not.
abstract boolean isDocumentEditorEnabled()
Indicates whether the document editor is enabled or not.
abstract boolean isDocumentInfoViewEnabled()
Indicates whether the document info view is enabled or not.
abstract boolean isImmersiveMode()
Indicates whether the immersive mode is activated or not.
abstract boolean isOutlineEnabled()
Indicates whether the outline is enabled or not.
abstract boolean isPrintingEnabled()
Indicates whether the printing support is enabled or not.
abstract boolean isRedactionUiEnabled()
Indicates whether we show the UI to apply redactions when there are RedactionAnnotation in the document.
abstract boolean isSearchEnabled()
Indicates whether the search is enabled or not.
abstract boolean isSettingsItemEnabled()
Indicates whether the settings menu item is shown or not.
abstract boolean isShowDocumentTitleOverlayEnabled()
Indicates whether the document title overlay is set to show or not.
abstract boolean isShowNavigationButtonsEnabled()
Indicates whether the navigation buttons are set to show or not.
abstract boolean isShowPageLabels()
Indicates whether the page labels are set to show or not.
abstract boolean isShowPageNumberOverlay()
Indicates whether the page number overlay is set to show or not.
abstract boolean isThumbnailGridEnabled()
Indicates whether the thumbnail grid is enabled or not.
abstract boolean isVolumeButtonsNavigationEnabled()
Indicates whether to use volume buttons for navigation between document pages.
abstract int page()
Returns the 0-indexed page number at which the document will be initially displayed.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Constants

public static final int NO_THEME

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

Constant Value: -1 (0xffffffff)

public static final int SEARCH_INLINE

Search type: inline.

Constant Value: 1 (0x00000001)

public static final int SEARCH_MODULAR

Search type: modular.

Constant Value: 2 (0x00000002)

Fields

public static final EnumSet<AnnotationType> DEFAULT_LISTED_ANNOTATION_TYPES

Annotation types listed by default.

Public Constructors

public PdfActivityConfiguration ()

Public Methods

public abstract String getActivityTitle ()

Returns the title set to the target activity.

Returns
  • Title for the activity.

public abstract PdfConfiguration getConfiguration ()

Returns configuration for the document.

Returns
  • Configuration for the core of PSPDFKit rendering engine.

public abstract int getDarkTheme ()

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

Returns
  • Theme resource id used by the launched activity in the night mode.

public abstract int getLayout ()

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

Returns
  • Layout resource used by the launched activity.

public abstract EnumSet<AnnotationType> getListedAnnotationTypes ()

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

Returns
  • Annotation types to be displayed if the list is enabled.

public abstract SearchConfiguration getSearchConfiguration ()

Returns the search configuration applied to the search views.

Returns
  • Search configuration for search views, holding properties used for performing search actions.

public abstract int getSearchType ()

Returns the search type set on the activity.

Returns

public abstract EnumSet<SettingsMenuItemType> getSettingsMenuItemShown ()

Returns items shown in the settings menu. If none are shown, settings menu icon is not shown either.

Returns
  • items shown in the settings menu.

public abstract TabBarHidingMode getTabBarHidingMode ()

Returns the tab bar hiding mode set on the activity.

Returns
  • Tab bar hiding mode set on the activity.

public abstract int getTheme ()

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

Returns
  • Theme resource id used by the launched activity.

public abstract ThumbnailBarMode getThumbnailBarMode ()

Returns the thumbnail bar mode set on the activity.

Returns
  • Thumbnail bar mode set on the activity.

public abstract UserInterfaceViewMode getUserInterfaceViewMode ()

Returns the user interface mode set on the activity.

Returns
  • System user interface mode set on the document.

public abstract boolean hideUserInterfaceWhenCreatingAnnotations ()

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

Returns
  • true when user interface should be hidden when showing vertical annotation creation toolbar.

public abstract boolean isAnnotationListEnabled ()

Indicates whether the list of annotations is enabled or not.

Returns
  • true if annotation list is enabled, false otherwise.

public abstract boolean isAnnotationListReorderingEnabled ()

Indicates whether reordering annotations in the annotation list is enabled.

Returns
  • true if reordering annotations in the annotation list is enabled, false otherwise.

public abstract boolean isAnnotationNoteHintingEnabled ()

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

Returns
  • true when annotation notes hints are enabled, false otherwise.

public abstract boolean isBookmarkEditingEnabled ()

Indicates whether the bookmarks can be edited or not.

Returns
  • true if bookmark list allows editing of bookmarks, false otherwise.

public abstract boolean isBookmarkListEnabled ()

Indicates whether the list of bookmarks is enabled or not.

Returns
  • true if bookmark list is enabled, false otherwise.

public abstract boolean isDocumentEditorEnabled ()

Indicates whether the document editor is enabled or not.

Returns
  • true if document editor is enabled, false otherwise.

public abstract boolean isDocumentInfoViewEnabled ()

Indicates whether the document info view is enabled or not.

Returns
  • true if document info view is enabled, false otherwise.

public abstract boolean isImmersiveMode ()

Indicates whether the immersive mode is activated or not.

Returns
  • true if immersive mode activated, false otherwise.

public abstract boolean isOutlineEnabled ()

Indicates whether the outline is enabled or not.

Returns
  • true if outline enabled, false otherwise.

public abstract boolean isPrintingEnabled ()

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

Returns
  • true if printing is enabled, false otherwise.

public abstract boolean isRedactionUiEnabled ()

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

Returns
  • true when the redaction UI should be displayed when false if it should not be displayed.

public abstract boolean isSearchEnabled ()

Indicates whether the search is enabled or not.

Returns
  • true if search is enabled, false otherwise.

public abstract boolean isSettingsItemEnabled ()

Indicates whether the settings menu item is shown or not.

Returns
  • true if settings menu item is enabled, false otherwise.

public abstract boolean isShowDocumentTitleOverlayEnabled ()

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

Returns
  • true if the document title overlay is set to show, false otherwise.

public abstract boolean isShowNavigationButtonsEnabled ()

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

Returns
  • true if the navigation buttons are set to show, false otherwise.

public abstract boolean isShowPageLabels ()

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

Returns
  • true if labels are enabled, false otherwise.

public abstract boolean isShowPageNumberOverlay ()

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

Returns
  • true if the page number overlay is set to show, false otherwise.

public abstract boolean isThumbnailGridEnabled ()

Indicates whether the thumbnail grid is enabled or not.

Returns
  • true if thumbnail grid is enabled, false otherwise.

public abstract boolean isVolumeButtonsNavigationEnabled ()

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

Returns
  • true when volume buttons will be used for navigation between document pages, false otherwise.

public abstract int page ()

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

Returns
  • Page at which to start the document.