Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.document.configuration/ReviewScreenConfiguration

ReviewScreenConfiguration

data class ReviewScreenConfiguration(var enabled: Boolean = true, var showLastPageWhenAdding: Boolean = false, var topBarTitle: StyledText = StyledText( text = "?reviewScreenTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var topBarMoreButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionReviewMoreButton" ), var topBarBackButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?reviewTopBarBackButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewTopBarBackButton", 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 morePopup: ReviewMorePopupMenu = ReviewMorePopupMenu( ), var zoomButton: RoundButton = RoundButton( accessibilityDescription = "?accessibilityDescriptionReviewZoomButton", backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var zoomOverlay: ZoomOverlay = ZoomOverlay( ), var backgroundColor: ScanbotColor = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false), var bottomBar: ReviewBottomBarConfiguration = ReviewBottomBarConfiguration( ), var switchNextPageButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionReviewNextPageButton" ), var switchPreviousPageButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionReviewPreviousPageButton" ), var pageCounter: UserGuidanceConfiguration = UserGuidanceConfiguration( title = StyledText( text = "?reviewScreenPageCount", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), background = BackgroundStyle( fillColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), strokeWidth = 0.0 ) ), var deleteAllPagesAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?reviewDeleteAllPagesAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?reviewDeleteAllPagesAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?reviewDeleteAllPagesAlertDeleteButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewDeleteAllPagesAlertDeleteButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), actionButton = ButtonConfiguration( visible = false ), cancelButton = ButtonConfiguration( text = "?reviewDeleteAllPagesAlertCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewDeleteAllPagesAlertCancelButton", background = BackgroundStyle( fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ) ), var deletePageAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?reviewDeletePageAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?reviewDeletePageAlertSubTitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?reviewDeletePageAlertConfirmButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewDeletePageAlertConfirmButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), actionButton = ButtonConfiguration( text = "?reviewDeletePageAlertDeleteRetakeButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewDeletePageAlertDeleteRetakeButton", background = BackgroundStyle( fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ), cancelButton = ButtonConfiguration( text = "?reviewDeletePageAlertCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewDeletePageAlertCancelButton", background = BackgroundStyle( fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ) )) : Parcelable

Configuration of the screen for reviewing the scanned pages.

Constructors

Link copied to clipboard
constructor(source: Map<String, Any?>)
constructor(json: JSONObject)
constructor(enabled: Boolean = true, showLastPageWhenAdding: Boolean = false, topBarTitle: StyledText = StyledText( text = "?reviewScreenTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), topBarMoreButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionReviewMoreButton" ), topBarBackButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?reviewTopBarBackButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewTopBarBackButton", 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 ) ), morePopup: ReviewMorePopupMenu = ReviewMorePopupMenu( ), zoomButton: RoundButton = RoundButton( accessibilityDescription = "?accessibilityDescriptionReviewZoomButton", backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), zoomOverlay: ZoomOverlay = ZoomOverlay( ), backgroundColor: ScanbotColor = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false), bottomBar: ReviewBottomBarConfiguration = ReviewBottomBarConfiguration( ), switchNextPageButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionReviewNextPageButton" ), switchPreviousPageButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionReviewPreviousPageButton" ), pageCounter: UserGuidanceConfiguration = UserGuidanceConfiguration( title = StyledText( text = "?reviewScreenPageCount", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), background = BackgroundStyle( fillColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), strokeWidth = 0.0 ) ), deleteAllPagesAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?reviewDeleteAllPagesAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?reviewDeleteAllPagesAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?reviewDeleteAllPagesAlertDeleteButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewDeleteAllPagesAlertDeleteButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), actionButton = ButtonConfiguration( visible = false ), cancelButton = ButtonConfiguration( text = "?reviewDeleteAllPagesAlertCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewDeleteAllPagesAlertCancelButton", background = BackgroundStyle( fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ) ), deletePageAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?reviewDeletePageAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?reviewDeletePageAlertSubTitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?reviewDeletePageAlertConfirmButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewDeletePageAlertConfirmButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), actionButton = ButtonConfiguration( text = "?reviewDeletePageAlertDeleteRetakeButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewDeletePageAlertDeleteRetakeButton", background = BackgroundStyle( fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ), cancelButton = ButtonConfiguration( text = "?reviewDeletePageAlertCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewDeletePageAlertCancelButton", 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 backgroundColor: ScanbotColor

The background color of the review screen.

Link copied to clipboard
var bottomBar: ReviewBottomBarConfiguration

Configuration of the bottom bar for the review screen.

Link copied to clipboard
var deleteAllPagesAlertDialog: ScanbotAlertDialog

Configuration of the alert dialog displayed when trying to delete all the pages.

Link copied to clipboard
var deletePageAlertDialog: ScanbotAlertDialog

Configuration of the alert dialog displayed when trying to delete a single page.

Link copied to clipboard
var enabled: Boolean

Determines whether the review screen should be shown or not. If 'false', the review screen will be skipped and the scanned document will be returned immediately.

Link copied to clipboard
var morePopup: ReviewMorePopupMenu

Configuration of the 'more' popup menu for the review screen.

Link copied to clipboard
var pageCounter: UserGuidanceConfiguration

Configuration of the page count label.

Link copied to clipboard
var showLastPageWhenAdding: Boolean

If set to true, the review screen, after adding a page, will automatically scroll to the last page. Otherwise the review screen will scroll to the first page.

Link copied to clipboard
var switchNextPageButton: IconButton

Configuration of the 'next page' button.

Link copied to clipboard
var switchPreviousPageButton: IconButton

Configuration of the 'previous page' button.

Link copied to clipboard
var topBarBackButton: ButtonConfiguration

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

Link copied to clipboard
var topBarMoreButton: IconButton

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

Link copied to clipboard
var topBarTitle: StyledText

Configuration of the title, located in the top bar.

Link copied to clipboard
var zoomButton: RoundButton

Configuration of the 'zoom' button.

Link copied to clipboard
var zoomOverlay: ZoomOverlay

Configuration of the zoom overlay for the review screen.

Functions

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