All Implemented Interfaces:: android.os.Parcelable


public final class MrzScannerIntroScreenConfiguration
 implements Parcelable

Configuration of the introduction screen for the MRZ scanner.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private MrzScannerIntroImage`	`image`
`private ScanbotColor`	`backgroundColor`
`private ScanbotColor`	`dividerColor`
`private ScanbotColor`	`handlerColor`
`private Boolean`	`showAutomatically`
`private StyledText`	`title`
`private StyledText`	`explanation`
`private ButtonConfiguration`	`doneButton`

Constructor Summary

Constructors
Constructor	Description
`MrzScannerIntroScreenConfiguration(Map<String, Object> source)`
`MrzScannerIntroScreenConfiguration(JSONObject json)`
`MrzScannerIntroScreenConfiguration(MrzScannerIntroImage image, ScanbotColor backgroundColor, ScanbotColor dividerColor, ScanbotColor handlerColor, Boolean showAutomatically, StyledText title, StyledText explanation, ButtonConfiguration doneButton)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final MrzScannerIntroImage`	`getImage()`	The image for the introduction screen.
`final Unit`	`setImage(MrzScannerIntroImage image)`	The image for the introduction screen.
`final ScanbotColor`	`getBackgroundColor()`	The background color of the introduction screen.
`final Unit`	`setBackgroundColor(ScanbotColor backgroundColor)`	The background color of the introduction screen.
`final ScanbotColor`	`getDividerColor()`	The divider color of the introduction screen.
`final Unit`	`setDividerColor(ScanbotColor dividerColor)`	The divider color of the introduction screen.
`final ScanbotColor`	`getHandlerColor()`	The handle color of the introduction screen.
`final Unit`	`setHandlerColor(ScanbotColor handlerColor)`	The handle color of the introduction screen.
`final Boolean`	`getShowAutomatically()`	Determines whether the introduction screen should automatically be shown or not when the scanning session starts.
`final Unit`	`setShowAutomatically(Boolean showAutomatically)`	Determines whether the introduction screen should automatically be shown or not when the scanning session starts.
`final StyledText`	`getTitle()`	The title of the introduction screen, located in the top bar.
`final Unit`	`setTitle(StyledText title)`	The title of the introduction screen, located in the top bar.
`final StyledText`	`getExplanation()`	The text explanation of the introduction screen.
`final Unit`	`setExplanation(StyledText explanation)`	The text explanation of the introduction screen.
`final ButtonConfiguration`	`getDoneButton()`	Configuration of the 'Done' / 'Start scanning' button.
`final Unit`	`setDoneButton(ButtonConfiguration doneButton)`	Configuration of the 'Done' / 'Start scanning' button.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final MrzScannerIntroScreenConfiguration`	`clone()`
`final static MrzScannerIntroScreenConfiguration`	`default()`

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

- Constructor Detail
  - MrzScannerIntroScreenConfiguration
```
MrzScannerIntroScreenConfiguration(Map<String, Object> source)
```
  - MrzScannerIntroScreenConfiguration
```
MrzScannerIntroScreenConfiguration(JSONObject json)
```
  - MrzScannerIntroScreenConfiguration
```
MrzScannerIntroScreenConfiguration(MrzScannerIntroImage image, ScanbotColor backgroundColor, ScanbotColor dividerColor, ScanbotColor handlerColor, Boolean showAutomatically, StyledText title, StyledText explanation, ButtonConfiguration doneButton)
```
- Method Detail
  - getImage
```
 final MrzScannerIntroImage getImage()
```
    The image for the introduction screen.
  - setImage
```
 final Unit setImage(MrzScannerIntroImage image)
```
    The image for the introduction screen.
  - getBackgroundColor
```
 final ScanbotColor getBackgroundColor()
```
    The background color of the introduction screen.
    Default is "?sbColorSurface"
  - setBackgroundColor
```
 final Unit setBackgroundColor(ScanbotColor backgroundColor)
```
    The background color of the introduction screen.
    Default is "?sbColorSurface"
  - getDividerColor
```
 final ScanbotColor getDividerColor()
```
    The divider color of the introduction screen.
    Default is "?sbColorOutline"
  - setDividerColor
```
 final Unit setDividerColor(ScanbotColor dividerColor)
```
    The divider color of the introduction screen.
    Default is "?sbColorOutline"
  - getHandlerColor
```
 final ScanbotColor getHandlerColor()
```
    The handle color of the introduction screen.
    Default is "?sbColorOutline"
  - setHandlerColor
```
 final Unit setHandlerColor(ScanbotColor handlerColor)
```
    The handle color of the introduction screen.
    Default is "?sbColorOutline"
  - getShowAutomatically
```
 final Boolean getShowAutomatically()
```
    Determines whether the introduction screen should automatically be shown or not when the scanning session starts.
    Default is false
  - setShowAutomatically
```
 final Unit setShowAutomatically(Boolean showAutomatically)
```
    Determines whether the introduction screen should automatically be shown or not when the scanning session starts.
    Default is false
  - getTitle
```
 final StyledText getTitle()
```
    The title of the introduction screen, located in the top bar.
  - setTitle
```
 final Unit setTitle(StyledText title)
```
    The title of the introduction screen, located in the top bar.
  - getExplanation
```
 final StyledText getExplanation()
```
    The text explanation of the introduction screen.
  - setExplanation
```
 final Unit setExplanation(StyledText explanation)
```
    The text explanation of the introduction screen.
  - getDoneButton
```
 final ButtonConfiguration getDoneButton()
```
    Configuration of the 'Done' / 'Start scanning' button.
  - setDoneButton
```
 final Unit setDoneButton(ButtonConfiguration doneButton)
```
    Configuration of the 'Done' / 'Start scanning' button.
  - toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 final MrzScannerIntroScreenConfiguration clone()
```
  - default
```
 final static MrzScannerIntroScreenConfiguration default()
```

Class MrzScannerIntroScreenConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MrzScannerIntroScreenConfiguration

MrzScannerIntroScreenConfiguration

MrzScannerIntroScreenConfiguration

Method Detail

getImage

setImage

getBackgroundColor

setBackgroundColor

getDividerColor

setDividerColor

getHandlerColor

setHandlerColor

getShowAutomatically

setShowAutomatically

getTitle

setTitle

getExplanation

setExplanation

getDoneButton

setDoneButton

toJson

clone

default