pspdfkit/com.pspdfkit.ui.redaction/RedactionView

RedactionView

open class RedactionView : FrameLayout

Responsible for the UI used to apply redactions.

Constructors

Link copied to clipboard
constructor(@NonNull context: Context)
constructor(@NonNull context: Context, @Nullable attrs: AttributeSet)
constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, defStyleAttr: Int)
constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, defStyleAttr: Int, defStyleRes: Int)

Types

Link copied to clipboard
interface RedactionViewListener
Listener receiving calls when redaction events are triggered.

Properties

Link copied to clipboard
val REDACTION_BUTTON_ICON_WIDTH_DP: Int = 48
Redaction button icon width.

Functions

Link copied to clipboard
open fun collapseRedactionOptions()
Collapses redaction menu options if expanded
Link copied to clipboard
open fun getRedactionButtonWidth(): Int
Returns the width in pixels of the redaction button.
Link copied to clipboard
open fun isButtonRedactionButtonVisible(): Boolean
Returns true if redaction button is visible.
Link copied to clipboard
open fun isRedactionAnnotationPreviewEnabled(): Boolean
Returns whether the redaction annotation preview mode is enabled or not.
Link copied to clipboard
open fun isRedactionButtonExpanded(): Boolean
Returns true if redaction button is visible and expanded.
Link copied to clipboard
open fun setBottomOffset(bottomOffset: Int)
Sets the bottom offset for the redaction button, used to make sure it doesn't overlay any other view.
Link copied to clipboard
open fun setListener(@Nullable listener: RedactionView.RedactionViewListener)
Sets the RedactionViewListener to notify when an action was clicked.
Link copied to clipboard
open fun setRedactionAnnotationPreviewEnabled(enable: Boolean)
Enables or disables redaction annotation preview mode.
Link copied to clipboard
open fun setRedactionButtonVisible(visible: Boolean, animate: Boolean)
Shows the button used to open the redaction menu.