Android Scanbot SDK/io.scanbot.sdk.ui_v2.document.configuration/DocumentCleanupScreenConfiguration

DocumentCleanupScreenConfiguration

data class DocumentCleanupScreenConfiguration(var topBarBackButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?documentCleanupTopBarCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionDocumentCleanupTopBarCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), var topBarTitle: StyledText = StyledText( text = "?documentCleanupScreenTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var topBarConfirmButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?documentCleanupTopBarConfirmButtonTitle", accessibilityDescription = "?accessibilityDescriptionDocumentCleanupTopBarConfirmButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), var backgroundColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var engineConfiguration: DocumentCleanupConfiguration = DocumentCleanupConfiguration( ), var toolbar: DocumentCleanupToolbarConfiguration = DocumentCleanupToolbarConfiguration( ), var introduction: DocumentCleanupIntroductionScreenConfiguration = DocumentCleanupIntroductionScreenConfiguration( ), var stroke: DocumentCleanupStroke = DocumentCleanupStroke( ), var resetAllEditsAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentCleanupResetAllEditsAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentCleanupResetAllEditsAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?documentCleanupResetAllEditsAlertResetButtonTitle", accessibilityDescription = "?accessibilityDescriptionDocumentCleanupResetAllEditsAlertResetButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), actionButton = ButtonConfiguration( visible = false ), cancelButton = ButtonConfiguration( text = "?documentCleanupResetAllEditsAlertCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionDocumentCleanupResetAllEditsAlertCancelButton", background = BackgroundStyle( fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ) ), var areaTooLargeAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentCleanupAreaTooLargeAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentCleanupAreaTooLargeAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?documentCleanupAreaTooLargeAlertButtonTitle", accessibilityDescription = "?accessibilityDescriptionDocumentCleanupAreaTooLargeAlertButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), cancelButton = ButtonConfiguration( visible = false ) ), var discardChangesAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentCleanupDiscardChangesAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentCleanupDiscardChangesAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?documentCleanupDiscardChangesAlertConfirmButtonTitle", accessibilityDescription = "?accessibilityDescriptionDocumentCleanupDiscardChangesAlertConfirmButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), actionButton = ButtonConfiguration( visible = false ), cancelButton = ButtonConfiguration( text = "?documentCleanupDiscardChangesAlertCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionDocumentCleanupDiscardChangesAlertCancelButton", background = BackgroundStyle( fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ) )) : Parcelable

Configuration of the screen for cleaning up scanned pages.

Constructors

Link copied to clipboard
constructor(source: Map<String, Any?>)
constructor(json: JSONObject)
constructor(topBarBackButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?documentCleanupTopBarCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionDocumentCleanupTopBarCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), topBarTitle: StyledText = StyledText( text = "?documentCleanupScreenTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), topBarConfirmButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?documentCleanupTopBarConfirmButtonTitle", accessibilityDescription = "?accessibilityDescriptionDocumentCleanupTopBarConfirmButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), backgroundColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), engineConfiguration: DocumentCleanupConfiguration = DocumentCleanupConfiguration( ), toolbar: DocumentCleanupToolbarConfiguration = DocumentCleanupToolbarConfiguration( ), introduction: DocumentCleanupIntroductionScreenConfiguration = DocumentCleanupIntroductionScreenConfiguration( ), stroke: DocumentCleanupStroke = DocumentCleanupStroke( ), resetAllEditsAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentCleanupResetAllEditsAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentCleanupResetAllEditsAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?documentCleanupResetAllEditsAlertResetButtonTitle", accessibilityDescription = "?accessibilityDescriptionDocumentCleanupResetAllEditsAlertResetButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), actionButton = ButtonConfiguration( visible = false ), cancelButton = ButtonConfiguration( text = "?documentCleanupResetAllEditsAlertCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionDocumentCleanupResetAllEditsAlertCancelButton", background = BackgroundStyle( fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ) ), areaTooLargeAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentCleanupAreaTooLargeAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentCleanupAreaTooLargeAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?documentCleanupAreaTooLargeAlertButtonTitle", accessibilityDescription = "?accessibilityDescriptionDocumentCleanupAreaTooLargeAlertButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), cancelButton = ButtonConfiguration( visible = false ) ), discardChangesAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?documentCleanupDiscardChangesAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?documentCleanupDiscardChangesAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?documentCleanupDiscardChangesAlertConfirmButtonTitle", accessibilityDescription = "?accessibilityDescriptionDocumentCleanupDiscardChangesAlertConfirmButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), actionButton = ButtonConfiguration( visible = false ), cancelButton = ButtonConfiguration( text = "?documentCleanupDiscardChangesAlertCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionDocumentCleanupDiscardChangesAlertCancelButton", background = BackgroundStyle( fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ) ))

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
var areaTooLargeAlertDialog: ScanbotAlertDialog

Configuration of the alert dialog displayed when the erased stroke area is too large to process.

Link copied to clipboard
var backgroundColor: ScanbotColor

The background color of the clean up screen.

Link copied to clipboard
var discardChangesAlertDialog: ScanbotAlertDialog

Configuration of the alert dialog displayed when the user tries to cancel with unsaved cleanup edits.

Link copied to clipboard
var engineConfiguration: DocumentCleanupConfiguration

Configuration of the underlying document cleanup engine.

Link copied to clipboard
var introduction: DocumentCleanupIntroductionScreenConfiguration

Configuration of the introduction screen for the clean up screen.

Link copied to clipboard
var resetAllEditsAlertDialog: ScanbotAlertDialog

Configuration of the alert dialog displayed when the user tries to reset all cleanup edits.

Link copied to clipboard
var stroke: DocumentCleanupStroke

Configuration of the stroke indicator and appearance for the clean up screen.

Link copied to clipboard
var toolbar: DocumentCleanupToolbarConfiguration

Configuration of the toolbar for the clean up screen.

Link copied to clipboard
var topBarBackButton: ButtonConfiguration

Configuration of the 'cancel' button, located in the top bar.

Link copied to clipboard
var topBarConfirmButton: ButtonConfiguration

Configuration of the 'confirm' button, located in the top bar.

Link copied to clipboard
var topBarTitle: StyledText

Configuration of the title, located in the top bar.

Functions

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