Package com.pspdfkit.ui.settings

Class SettingsOptions

  • All Implemented Interfaces:
    java.io.Serializable 
    
public class SettingsOptions
 implements Serializable

    Data class that represents the options to be shown in the SettingsDialog. Generally you wouldn't need to deal with this class, as it's automatically created by the internal PdfUi implementation from values of the active PdfConfiguration.

    • Method Detail

      • getScreenTimeoutMillis

         final Long getScreenTimeoutMillis()

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

        @Override
fun onUserInteraction() {
    super.onUserInteraction();
    pdfUiFragment.implementation.onUserInteraction();
}

      • setScreenTimeoutMillis

         final Unit setScreenTimeoutMillis(Long screenTimeoutMillis)

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

        @Override
fun onUserInteraction() {
    super.onUserInteraction();
    pdfUiFragment.implementation.onUserInteraction();
}

      • getVisibleItems

         final EnumSet<SettingsMenuItemType> getVisibleItems()

        Items that should be visible in the settings dialog. See PdfActivityConfiguration.getSettingsMenuItemShown. Providing an empty set results in the same behavior as PdfActivityConfiguration.Builder.hideSettingsMenu and will remove the settings dialog item from the main options menu.

      • getSnapToSelf

         final Boolean getSnapToSelf()

        Enables snapping to itself at the end of shape drawing.