DocumentState

All Implemented Interfaces:

com.pspdfkit.listeners.OnVisibilityChangedListener
```
public abstract class DocumentState
 implements 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.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

Field Summary

Fields
Modifier and Type Field Description

private final StateFlow<Boolean> viewWithOverlappingToolbarShown

private DocumentConnection documentConnection

Constructor Summary

Constructors

Constructor Description

Enum Constant Summary

Enum Constants
Enum Constant Description

Method Summary

Modifier and Type	Method	Description
`final StateFlow<Boolean>`	`getViewWithOverlappingToolbarShown()`	Keep track of whether a full screen view is shown that is not the document view so we can handle the main toolbar clipping
`final DocumentConnection`	`getDocumentConnection()`	Provides ability to perform specific tasks in Document.
`final Unit`	`setDocumentConnection(DocumentConnection documentConnection)`	Provides ability to perform specific tasks in Document.
`abstract String`	`getTitle()`	Provides the title of the document.
`final Unit`	`toggleView(Integer option)`	Toggles the view based on the provided MENU_OPTIONS in com.pspdfkit.ui.PdfActivity.
`Unit`	`onShow(View view)`	Called whenever a PSPDFKit view has become visible.
`Unit`	`onHide(View view)`	Called whenever a PSPDFKit view has been hidden.

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

- Constructor Detail
- Method Detail
  - getViewWithOverlappingToolbarShown
```
 final StateFlow<Boolean> getViewWithOverlappingToolbarShown()
```
    Keep track of whether a full screen view is shown that is not the document view so we can handle the main toolbar clipping
  - getDocumentConnection
```
 final DocumentConnection getDocumentConnection()
```
    Provides ability to perform specific tasks in Document.
  - setDocumentConnection
```
 final Unit setDocumentConnection(DocumentConnection documentConnection)
```
    Provides ability to perform specific tasks in Document.
  - getTitle
```
 abstract String getTitle()
```
    Provides the title of the document.
  - toggleView
```
 final Unit toggleView(Integer option)
```
    Toggles the view based on the provided MENU_OPTIONS in com.pspdfkit.ui.PdfActivity.
    
    Parameters:
    
    option - The menu id of view to toggle.
  - onShow
```
 Unit onShow(View view)
```
    Called whenever a PSPDFKit view has become visible.
  - onHide
```
 Unit onHide(View view)
```
    Called whenever a PSPDFKit view has been hidden.