sdk-pspdfkit/com.pspdfkit.jetpack.compose.interactors/DocumentState

DocumentState

abstract class DocumentState : OnVisibilityChangedListener

A state object that can be hoisted to control and observe properties of the com.pspdfkit.jetpack.compose.views.DocumentView. Create instances of this object using rememberDocumentState.

Parameters

configuration

The PdfActivityConfiguration used for this state.

Properties

Link copied to clipboard
var documentConnection: DocumentConnection

Provides ability to perform specific tasks in Document.

Link copied to clipboard
val viewWithOverlappingToolbarShown: StateFlow<Boolean>

Keep track of whether a full screen view is shown that is not the document view so we can handle the main toolbar clipping

Functions

Link copied to clipboard
fun exitCurrentState()

Reverts back to viewer from any other State.

Link copied to clipboard
abstract fun getTitle(): String?

Provides the title of the document.

Link copied to clipboard
fun isDefaultViewerActive(): Boolean

Checks if viewer is visible or not.

Link copied to clipboard
open override fun onHide(view: View)

Called whenever a PSPDFKit view has been hidden.

Link copied to clipboard
open override fun onShow(view: View)

Called whenever a PSPDFKit view has become visible.

Link copied to clipboard
fun setOnContextualToolbarLifecycleListener(listener: ToolbarCoordinatorLayout.OnContextualToolbarLifecycleListener)

Set the ToolbarCoordinatorLayout.OnContextualToolbarLifecycleListener to listen to the lifecycle of the contextual toolbar. Can be implemented in a LaunchedScope to handle the lifecycle of the contextual toolbar, i.e. LaunchedEffect(Unit) { documentState.setOnContextualToolbarLifecycleListener(object : ToolbarCoordinatorLayout.OnContextualToolbarLifecycleListener { override fun onPrepareContextualToolbar(toolbar: ContextualToolbar<*>) { if (toolbar is AnnotationCreationToolbar) { // Register grouping rule to tell toolbar how to group menu items. toolbar.setMenuItemGroupingRule(object : PresetMenuItemGroupingRule(context) { override fun getGroupPreset(capacity: Int, itemsCount: Int) = AnnotationCreationToolbarItemPresets.FOUR_ITEMS_GROUPING; }) } } }) }

Link copied to clipboard
fun toggleView(option: Int)

Toggles the view based on the provided MENU_OPTIONS in com.pspdfkit.ui.PdfActivity.