SettingsOptions

open class SettingsOptions @JvmOverloads constructor(var scrollDirection: PageScrollDirection, var scrollMode: PageScrollMode, var layoutMode: PageLayoutMode, var themeMode: ThemeMode, var screenTimeoutMillis: Long, val visibleItems: EnumSet<SettingsMenuItemType>, var sepia: Boolean = false) : Serializable

Data class that represents the options to be shown in the com.pspdfkit.ui.settings.SettingsDialog. It is created automatically from the values of the active com.pspdfkit.configuration.PdfConfiguration, so you do not need to build one to use the built-in settings dialog.

You do need it if you replace the settings dialog with your own UI, because it is the carrier between that UI and the SDK. Read the current values into one, render whatever controls you like, and apply the result back through com.pspdfkit.configuration.PdfConfiguration, com.pspdfkit.ui.PdfUi.setScreenTimeout and com.pspdfkit.preferences.PSPDFKitPreferences. The catalog's Custom Settings, Info and Outline UI example does exactly that, using public API only.

Constructors

Link copied to clipboard
constructor(scrollDirection: PageScrollDirection, scrollMode: PageScrollMode, layoutMode: PageLayoutMode, themeMode: ThemeMode, screenTimeoutMillis: Long, visibleItems: EnumSet<SettingsMenuItemType>, sepia: Boolean = false)

Properties

Link copied to clipboard
Link copied to clipboard

Specifies the duration that needs to pass without user interaction until the screen is turned off. Use com.pspdfkit.ui.PdfUi.TIMEOUT_DEFAULT for the system default timeout and com.pspdfkit.ui.PdfUi.TIMEOUT_INFINITE to deactivate automatic screen off. Please notice, that this setting only works out of the box only if you're using com.pspdfkit.ui.PdfActivity (or a derived class from it). In case you're using com.pspdfkit.ui.PdfUiFragment you can forward Activity.onUserInteraction from your activity class.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Items that should be visible in the settings dialog. See com.pspdfkit.configuration.activity.PdfActivityConfiguration.settingsMenuItemShown. Providing an empty set results in the same behavior as calling com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder.settingsMenuEnabled with false and will remove the settings dialog item from the main options menu.

Functions

Link copied to clipboard

Compares this settings options object with another for equality of all properties.

Link copied to clipboard

Creates a copy of this settings options object with all properties duplicated.

Link copied to clipboard
open override fun toString(): String

Returns a string representation of this settings options object.