DocumentCleanupIntroductionScreenConfiguration

data class DocumentCleanupIntroductionScreenConfiguration(var backgroundColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false), var dividerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var handlerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var showAutomatically: Boolean = true, var title: StyledText = StyledText( text = "?documentCleanupIntroductionTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), var closeButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?documentCleanupIntroductionCloseButton", accessibilityDescription = "?accessibilityDescriptionDocumentCleanupIntroductionCloseButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), var draw: DocumentCleanupIntroductionItem = DocumentCleanupIntroductionItem( title = StyledText( text = "?documentCleanupIntroductionDrawTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), content = StyledText( text = "?documentCleanupIntroductionDrawContent", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ), var pinch: DocumentCleanupIntroductionItem = DocumentCleanupIntroductionItem( title = StyledText( text = "?documentCleanupIntroductionPinchTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), content = StyledText( text = "?documentCleanupIntroductionPinchContent", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ), var move: DocumentCleanupIntroductionItem = DocumentCleanupIntroductionItem( title = StyledText( text = "?documentCleanupIntroductionMoveTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), content = StyledText( text = "?documentCleanupIntroductionMoveContent", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) )) : Parcelable

Configuration of the introduction screen for the clean up screen.

Constructors

constructor(source: Map<String, Any?>)
constructor(json: JSONObject)
constructor(backgroundColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false), dividerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), handlerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), showAutomatically: Boolean = true, title: StyledText = StyledText( text = "?documentCleanupIntroductionTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), closeButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?documentCleanupIntroductionCloseButton", accessibilityDescription = "?accessibilityDescriptionDocumentCleanupIntroductionCloseButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), draw: DocumentCleanupIntroductionItem = DocumentCleanupIntroductionItem( title = StyledText( text = "?documentCleanupIntroductionDrawTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), content = StyledText( text = "?documentCleanupIntroductionDrawContent", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ), pinch: DocumentCleanupIntroductionItem = DocumentCleanupIntroductionItem( title = StyledText( text = "?documentCleanupIntroductionPinchTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), content = StyledText( text = "?documentCleanupIntroductionPinchContent", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ), move: DocumentCleanupIntroductionItem = DocumentCleanupIntroductionItem( title = StyledText( text = "?documentCleanupIntroductionMoveTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), content = StyledText( text = "?documentCleanupIntroductionMoveContent", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ))

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The background color of the introduction screen.

Link copied to clipboard

Configuration of the button that closes the introduction screen.

Link copied to clipboard

The divider color of the introduction screen.

Link copied to clipboard

Configuration of the 'draw to erase' instruction item.

Link copied to clipboard

The handle color of the introduction screen.

Link copied to clipboard

Configuration of the 'move the page' instruction item.

Link copied to clipboard

Configuration of the 'pinch to zoom' instruction item.

Link copied to clipboard

Determines whether the introduction screen should automatically be shown or not when the clean up screen opens.

Link copied to clipboard

The title of the introduction screen.

Functions

Link copied to clipboard
fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject