pspdfkit/com.pspdfkit.ui.inspector/PropertyInspectorCoordinatorLayout

PropertyInspectorCoordinatorLayout

open class PropertyInspectorCoordinatorLayout : CoordinatorLayout, PropertyInspectorCoordinatorLayoutController

This layout is responsible for handling PropertyInspectors. It is used in , but it can be added to any view group, for example to the root view of the custom activity.

PSPDFKit ships with property inspector controllers that manage property inspector lifecycle for built in inspectors:

AnnotationCreationInspectorController - manages annotation properties inspector in annotation creation mode
AnnotationEditingInspectorController - manages annotation properties inspector in annotation editing mode
FormEditingInspectorController - manages bottom sheet displayed when filling choice form elements

We recommend to use these controllers instead of manually managing your UI.

Constructors

PropertyInspectorCoordinatorLayout

constructor(@NonNull context: Context)

constructor(@NonNull context: Context, @Nullable attrs: AttributeSet)

constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, @AttrRes defStyleAttr: Int)

Functions

addPropertyInspectorLifecycleListener

open fun addPropertyInspectorLifecycleListener(@NonNull lifecycleListener: PropertyInspectorCoordinatorLayoutController.PropertyInspectorLifecycleListener)

Adds the listener for lifecycle changes of the PropertyInspector as it goes through the PropertyInspectorCoordinatorLayout - preparing, displaying, removing.

hideInspector

@UiThread

open fun hideInspector(animate: Boolean): Boolean

Removes active inspector if visible.

isInspectorVisible

open fun isInspectorVisible(): Boolean

Tests if coordinator has any active inspector currently visible.

open fun isInspectorVisible(@NonNull inspector: PropertyInspector): Boolean

Tests if inspector is currently active in coordinator.

onDetachedFromWindow

open fun onDetachedFromWindow()

removePropertyInspectorLifecycleListener

open fun removePropertyInspectorLifecycleListener(@NonNull lifecycleListener: PropertyInspectorCoordinatorLayoutController.PropertyInspectorLifecycleListener)

Removes previously registered listener for lifecycle changes of the PropertyInspector as it goes through the PropertyInspectorCoordinatorLayout - preparing, displaying, removing.

setBottomInset

open fun setBottomInset(bottomInset: Int)

Sets bottom inset for displayed PropertyInspectors.

setDrawUnderBottomInset

open fun setDrawUnderBottomInset(showInspectorViewsUnderBottomInset: Boolean)

Controls whether inspector contents are drawn under bottom insets (system or set via setBottomInset.

setFitsSystemWindows

open fun setFitsSystemWindows(fitSystemWindows: Boolean)

showInspector

@UiThread

open fun showInspector(@NonNull propertyInspector: PropertyInspector, animate: Boolean): Boolean

Displays property inspector.