All Implemented Interfaces:: android.os.Parcelable


public final class IntroductionScreenConfiguration
 implements Parcelable

Configuration of the introduction screen for the document scanner.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private ScanbotColor`	`backgroundColor`
`private ScanbotColor`	`dividerColor`
`private ScanbotColor`	`handlerColor`
`private Boolean`	`showAutomatically`
`private ButtonConfiguration`	`topBarDoneButton`
`private StyledText`	`title`
`private StyledText`	`subtitle`
`private List<IntroListEntry>`	`items`

Constructor Summary

Constructors
Constructor	Description
`IntroductionScreenConfiguration(Map<String, Object> source)`
`IntroductionScreenConfiguration(JSONObject json)`
`IntroductionScreenConfiguration(ScanbotColor backgroundColor, ScanbotColor dividerColor, ScanbotColor handlerColor, Boolean showAutomatically, ButtonConfiguration topBarDoneButton, StyledText title, StyledText subtitle, List<IntroListEntry> items)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`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 ButtonConfiguration`	`getTopBarDoneButton()`	Configuration of the 'done' button, located in the top bar.
`final Unit`	`setTopBarDoneButton(ButtonConfiguration topBarDoneButton)`	Configuration of the 'done' button, located in the top bar.
`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`	`getSubtitle()`	The subtitle of the introduction screen.
`final Unit`	`setSubtitle(StyledText subtitle)`	The subtitle of the introduction screen.
`final List<IntroListEntry>`	`getItems()`	Configure the scanning steps of the introduction screen.
`final Unit`	`setItems(List<IntroListEntry> items)`	Configure the scanning steps of the introduction screen.
`final JSONObject`	`toJson()`
`final static IntroductionScreenConfiguration`	`default()`

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

- Constructor Detail
  - IntroductionScreenConfiguration
```
IntroductionScreenConfiguration(Map<String, Object> source)
```
  - IntroductionScreenConfiguration
```
IntroductionScreenConfiguration(JSONObject json)
```
  - IntroductionScreenConfiguration
```
IntroductionScreenConfiguration(ScanbotColor backgroundColor, ScanbotColor dividerColor, ScanbotColor handlerColor, Boolean showAutomatically, ButtonConfiguration topBarDoneButton, StyledText title, StyledText subtitle, List<IntroListEntry> items)
```
- Method Detail
  - 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
  - getTopBarDoneButton
```
 final ButtonConfiguration getTopBarDoneButton()
```
    Configuration of the 'done' button, located in the top bar.
  - setTopBarDoneButton
```
 final Unit setTopBarDoneButton(ButtonConfiguration topBarDoneButton)
```
    Configuration of the 'done' button, located in the top bar.
  - 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.
  - getSubtitle
```
 final StyledText getSubtitle()
```
    The subtitle of the introduction screen.
  - setSubtitle
```
 final Unit setSubtitle(StyledText subtitle)
```
    The subtitle of the introduction screen.
  - getItems
```
 final List<IntroListEntry> getItems()
```
    Configure the scanning steps of the introduction screen.
  - setItems
```
 final Unit setItems(List<IntroListEntry> items)
```
    Configure the scanning steps of the introduction screen.
  - toJson
```
 final JSONObject toJson()
```
  - default
```
 final static IntroductionScreenConfiguration default()
```

Class IntroductionScreenConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IntroductionScreenConfiguration

IntroductionScreenConfiguration

IntroductionScreenConfiguration

Method Detail

getBackgroundColor

setBackgroundColor

getDividerColor

setDividerColor

getHandlerColor

setHandlerColor

getShowAutomatically

setShowAutomatically

getTopBarDoneButton

setTopBarDoneButton

getTitle

setTitle

getSubtitle

setSubtitle

getItems

setItems

toJson

default