All Implemented Interfaces:: android.os.Parcelable


public final class ReviewScreenConfiguration
 implements Parcelable

Configuration of the screen for reviewing the scanned pages.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private Boolean`	`enabled`
`private StyledText`	`topBarTitle`
`private IconButton`	`topBarMoreButton`
`private ButtonConfiguration`	`topBarBackButton`
`private ReviewMorePopupMenu`	`morePopup`
`private RoundButton`	`zoomButton`
`private ZoomOverlay`	`zoomOverlay`
`private ScanbotColor`	`backgroundColor`
`private ReviewBottomBarConfiguration`	`bottomBar`
`private IconButton`	`switchNextPageButton`
`private IconButton`	`switchPreviousPageButton`
`private UserGuidanceConfiguration`	`pageCounter`
`private ScanbotAlertDialog`	`deleteAllPagesAlertDialog`
`private ScanbotAlertDialog`	`deletePageAlertDialog`

Constructor Summary

Constructors
Constructor	Description
`ReviewScreenConfiguration(Map<String, Object> source)`
`ReviewScreenConfiguration(JSONObject json)`
`ReviewScreenConfiguration(Boolean enabled, StyledText topBarTitle, IconButton topBarMoreButton, ButtonConfiguration topBarBackButton, ReviewMorePopupMenu morePopup, RoundButton zoomButton, ZoomOverlay zoomOverlay, ScanbotColor backgroundColor, ReviewBottomBarConfiguration bottomBar, IconButton switchNextPageButton, IconButton switchPreviousPageButton, UserGuidanceConfiguration pageCounter, ScanbotAlertDialog deleteAllPagesAlertDialog, ScanbotAlertDialog deletePageAlertDialog)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getEnabled()`	Determines whether the review screen should be shown or not.
`final Unit`	`setEnabled(Boolean enabled)`	Determines whether the review screen should be shown or not.
`final StyledText`	`getTopBarTitle()`	Configuration of the title, located in the top bar.
`final Unit`	`setTopBarTitle(StyledText topBarTitle)`	Configuration of the title, located in the top bar.
`final IconButton`	`getTopBarMoreButton()`	Configuration of the 'more' button, located in the top bar.
`final Unit`	`setTopBarMoreButton(IconButton topBarMoreButton)`	Configuration of the 'more' button, located in the top bar.
`final ButtonConfiguration`	`getTopBarBackButton()`	Configuration of the 'back' button, located in the top bar.
`final Unit`	`setTopBarBackButton(ButtonConfiguration topBarBackButton)`	Configuration of the 'back' button, located in the top bar.
`final ReviewMorePopupMenu`	`getMorePopup()`	Configuration of the 'more' popup menu for the review screen.
`final Unit`	`setMorePopup(ReviewMorePopupMenu morePopup)`	Configuration of the 'more' popup menu for the review screen.
`final RoundButton`	`getZoomButton()`	Configuration of the 'zoom' button.
`final Unit`	`setZoomButton(RoundButton zoomButton)`	Configuration of the 'zoom' button.
`final ZoomOverlay`	`getZoomOverlay()`	Configuration of the zoom overlay for the review screen.
`final Unit`	`setZoomOverlay(ZoomOverlay zoomOverlay)`	Configuration of the zoom overlay for the review screen.
`final ScanbotColor`	`getBackgroundColor()`	The background color of the review screen.
`final Unit`	`setBackgroundColor(ScanbotColor backgroundColor)`	The background color of the review screen.
`final ReviewBottomBarConfiguration`	`getBottomBar()`	Configuration of the bottom bar for the review screen.
`final Unit`	`setBottomBar(ReviewBottomBarConfiguration bottomBar)`	Configuration of the bottom bar for the review screen.
`final IconButton`	`getSwitchNextPageButton()`	Configuration of the 'next page' button.
`final Unit`	`setSwitchNextPageButton(IconButton switchNextPageButton)`	Configuration of the 'next page' button.
`final IconButton`	`getSwitchPreviousPageButton()`	Configuration of the 'previous page' button.
`final Unit`	`setSwitchPreviousPageButton(IconButton switchPreviousPageButton)`	Configuration of the 'previous page' button.
`final UserGuidanceConfiguration`	`getPageCounter()`	Configuration of the page count label.
`final Unit`	`setPageCounter(UserGuidanceConfiguration pageCounter)`	Configuration of the page count label.
`final ScanbotAlertDialog`	`getDeleteAllPagesAlertDialog()`	Configuration of the alert dialog displayed when trying to delete all the pages.
`final Unit`	`setDeleteAllPagesAlertDialog(ScanbotAlertDialog deleteAllPagesAlertDialog)`	Configuration of the alert dialog displayed when trying to delete all the pages.
`final ScanbotAlertDialog`	`getDeletePageAlertDialog()`	Configuration of the alert dialog displayed when trying to delete a single page.
`final Unit`	`setDeletePageAlertDialog(ScanbotAlertDialog deletePageAlertDialog)`	Configuration of the alert dialog displayed when trying to delete a single page.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final ReviewScreenConfiguration`	`clone()`
`final static ReviewScreenConfiguration`	`default()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ReviewScreenConfiguration
```
ReviewScreenConfiguration(Map<String, Object> source)
```
  - ReviewScreenConfiguration
```
ReviewScreenConfiguration(JSONObject json)
```
  - ReviewScreenConfiguration
```
ReviewScreenConfiguration(Boolean enabled, StyledText topBarTitle, IconButton topBarMoreButton, ButtonConfiguration topBarBackButton, ReviewMorePopupMenu morePopup, RoundButton zoomButton, ZoomOverlay zoomOverlay, ScanbotColor backgroundColor, ReviewBottomBarConfiguration bottomBar, IconButton switchNextPageButton, IconButton switchPreviousPageButton, UserGuidanceConfiguration pageCounter, ScanbotAlertDialog deleteAllPagesAlertDialog, ScanbotAlertDialog deletePageAlertDialog)
```
- Method Detail
  - getEnabled
```
 final Boolean getEnabled()
```
    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.
    Default is true
  - setEnabled
```
 final Unit setEnabled(Boolean enabled)
```
    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.
    Default is true
  - getTopBarTitle
```
 final StyledText getTopBarTitle()
```
    Configuration of the title, located in the top bar.
  - setTopBarTitle
```
 final Unit setTopBarTitle(StyledText topBarTitle)
```
    Configuration of the title, located in the top bar.
  - getTopBarMoreButton
```
 final IconButton getTopBarMoreButton()
```
    Configuration of the 'more' button, located in the top bar.
  - setTopBarMoreButton
```
 final Unit setTopBarMoreButton(IconButton topBarMoreButton)
```
    Configuration of the 'more' button, located in the top bar.
  - getTopBarBackButton
```
 final ButtonConfiguration getTopBarBackButton()
```
    Configuration of the 'back' button, located in the top bar.
  - setTopBarBackButton
```
 final Unit setTopBarBackButton(ButtonConfiguration topBarBackButton)
```
    Configuration of the 'back' button, located in the top bar.
  - getMorePopup
```
 final ReviewMorePopupMenu getMorePopup()
```
    Configuration of the 'more' popup menu for the review screen.
  - setMorePopup
```
 final Unit setMorePopup(ReviewMorePopupMenu morePopup)
```
    Configuration of the 'more' popup menu for the review screen.
  - getZoomButton
```
 final RoundButton getZoomButton()
```
    Configuration of the 'zoom' button.
  - setZoomButton
```
 final Unit setZoomButton(RoundButton zoomButton)
```
    Configuration of the 'zoom' button.
  - getZoomOverlay
```
 final ZoomOverlay getZoomOverlay()
```
    Configuration of the zoom overlay for the review screen.
  - setZoomOverlay
```
 final Unit setZoomOverlay(ZoomOverlay zoomOverlay)
```
    Configuration of the zoom overlay for the review screen.
  - getBackgroundColor
```
 final ScanbotColor getBackgroundColor()
```
    The background color of the review screen.
    Default is "?sbColorOnSurfaceVariant"
  - setBackgroundColor
```
 final Unit setBackgroundColor(ScanbotColor backgroundColor)
```
    The background color of the review screen.
    Default is "?sbColorOnSurfaceVariant"
  - getBottomBar
```
 final ReviewBottomBarConfiguration getBottomBar()
```
    Configuration of the bottom bar for the review screen.
  - setBottomBar
```
 final Unit setBottomBar(ReviewBottomBarConfiguration bottomBar)
```
    Configuration of the bottom bar for the review screen.
  - getSwitchNextPageButton
```
 final IconButton getSwitchNextPageButton()
```
    Configuration of the 'next page' button.
  - setSwitchNextPageButton
```
 final Unit setSwitchNextPageButton(IconButton switchNextPageButton)
```
    Configuration of the 'next page' button.
  - getSwitchPreviousPageButton
```
 final IconButton getSwitchPreviousPageButton()
```
    Configuration of the 'previous page' button.
  - setSwitchPreviousPageButton
```
 final Unit setSwitchPreviousPageButton(IconButton switchPreviousPageButton)
```
    Configuration of the 'previous page' button.
  - getPageCounter
```
 final UserGuidanceConfiguration getPageCounter()
```
    Configuration of the page count label.
  - setPageCounter
```
 final Unit setPageCounter(UserGuidanceConfiguration pageCounter)
```
    Configuration of the page count label.
  - getDeleteAllPagesAlertDialog
```
 final ScanbotAlertDialog getDeleteAllPagesAlertDialog()
```
    Configuration of the alert dialog displayed when trying to delete all the pages.
  - setDeleteAllPagesAlertDialog
```
 final Unit setDeleteAllPagesAlertDialog(ScanbotAlertDialog deleteAllPagesAlertDialog)
```
    Configuration of the alert dialog displayed when trying to delete all the pages.
  - getDeletePageAlertDialog
```
 final ScanbotAlertDialog getDeletePageAlertDialog()
```
    Configuration of the alert dialog displayed when trying to delete a single page.
  - setDeletePageAlertDialog
```
 final Unit setDeletePageAlertDialog(ScanbotAlertDialog deletePageAlertDialog)
```
    Configuration of the alert dialog displayed when trying to delete a single page.
  - toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 final ReviewScreenConfiguration clone()
```
  - default
```
 final static ReviewScreenConfiguration default()
```

Class ReviewScreenConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReviewScreenConfiguration

ReviewScreenConfiguration

ReviewScreenConfiguration

Method Detail

getEnabled

setEnabled

getTopBarTitle

setTopBarTitle

getTopBarMoreButton

setTopBarMoreButton

getTopBarBackButton

setTopBarBackButton

getMorePopup

setMorePopup

getZoomButton

setZoomButton

getZoomOverlay

setZoomOverlay

getBackgroundColor

setBackgroundColor

getBottomBar

setBottomBar

getSwitchNextPageButton

setSwitchNextPageButton

getSwitchPreviousPageButton

setSwitchPreviousPageButton

getPageCounter

setPageCounter

getDeleteAllPagesAlertDialog

setDeleteAllPagesAlertDialog

getDeletePageAlertDialog

setDeletePageAlertDialog

toJson

clone

default